Skip to content

Commit

Permalink
chore: update-readme (#157)
Browse files Browse the repository at this point in the history
  • Loading branch information
gaspb authored Mar 28, 2024
1 parent e196dc6 commit 8a5d215
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 16 deletions.
91 changes: 75 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Like this project ? Leave us a star ⭐ or join us in the discussions 💬
</div>

<br/><br/>
<br/>

<div align="center">
<a href="https://www.meteroid.com?utm_source=github" target="_blank">
Expand All @@ -26,41 +26,100 @@
<a href="CODE_OF_CONDUCT.md">
<img src="https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg" alt="Code of conduct">
</a>
<a href="LICENSE.md">
<a href="LICENSE">
<img src="https://img.shields.io/badge/license-AGPL%20V3-blue" alt="AGPL V3">
</a>
<a href="https://go.meteroid.com/discord?utm_source=github">
<img src="https://img.shields.io/discord/1202199422910595155?logo=Discord&logoColor=%23FFFFFF&style=plastic" alt="Discord">
</a>
<img src="https://img.shields.io/badge/status-experimental-red" alt="Experimental">
<a href="https://twitter.com/meteroidhq">
<img alt="Twitter" src="https://img.shields.io/twitter/url.svg?label=meteroidhq&style=social&url=https%3A%2F%2Ftwitter.com%2Fmeteroidhq" />
</a>
</p>


<h4 align="center">
Open-source alternative to Chargebee, Metronome, Orb, Stripe Billing, made for scale and extensibility !
</h4>
<div>
<span>

---
Meteroid addresses the complexities and limitations of traditional billing systems, particularly for businesses transitioning to usage-based models or product-led-growth principles.
It eliminates the gap between customer usage and billing, ensuring accuracy and transparency.

<div align="center" flex>


<b>⚠️ Meteroid is in ALPHA </b>
<br/>
<b>Not all feature are finished, and the API is not stable. </b>

<br/>

<span>We are working fulltime on our first stable release, and on improving our DX and UX.</span>
</span>
</div>

---




<p align="center">
<img src="assets/meteroid-banner.png" alt="Meteroid Billing Infrastructure Banner" width="640" >
</p>

<a href="https://meteroid.com/talk-to-us">
Talk to us !
</a>
<br/>

# Developer Guide



## How It Works

Meteroid integrates with your existing systems via a simple API, collecting data on customer usage and interactions.
This data fuels the Meteroid billing engine, applying your custom pricing models to generate accurate, timely invoices.

Our platform simplifies the creation, scaling and maintenance of complex billing models, automates invoice generation, and provides *clear, actionable insights* for achieving your KPIs.


<p align="center">
<img
src="assets/meteroid-schema-4.webp"
alt="Meteroid Schema"
width="640"
/>
</p>


## For whom ?

Meteroid is designed for startups, SMEs, and enterprises looking to embrace some form of usage-based billing or product-led growth.

## Build for Sustainable Growth

Our philosophy is deeply rooted in the principles of open source and open startup culture. <br/>
We believe in **transparency** and **collaboration** as foundational pillars that not only foster innovation but also build trust and community around our mission.

By choosing Rust as our core technology, we leverage its efficiency, reliability, and safety features, ensuring our platform is built on a solid, secure foundation.

Our focus on Product-Led Growth (PLG) reflects our commitment to creating products that drive user acquisition, retention, and expansion through their inherent value and user experience

This approach, combined with our open philosophy, guides us toward creating a more inclusive, sustainable future for the SaaS industries.


## Developer Guide

> [!WARNING]
>
> Meteroid is in **ALPHA**, and is to be considered unstable.
>
> We are working fulltime on a stable release.

Please refer to the [contributing guide](CONTRIBUTING.md) for how to install Meteroid from sources.

## License

Copyright 2024 Meteroid

Licensed under the AGPL V3 License. <br/> See [LICENSE.md](LICENSE.md) for more information.

## Contributors ✨

<a href="https://github.com/meteroid-oss/meteroid/graphs/contributors">
<p align="left">
<img width="220" src="https://contrib.rocks/image?repo=meteroid-oss/meteroid" alt="A table of avatars from the project's contributors" />
</p>
</a>
Binary file added assets/meteroid-schema-4.webp
Binary file not shown.

0 comments on commit 8a5d215

Please sign in to comment.