Simplify README
This commit is contained in:
parent
97cffd8d17
commit
aae478543d
15
README.md
15
README.md
|
@ -31,7 +31,19 @@
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Progress Tracker/Roadmap:
|
## About
|
||||||
|
|
||||||
|
Chorus is a Rust library that allows developers to interact with multiple Spacebar-compatible APIs and Gateways simultaneously. The library provides a simple and efficient way to communicate with these services, making it easier for developers to build applications that rely on them. Chorus is open-source and welcomes contributions from the community.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
If you would like to contribute, please feel free to open an Issue with the idea you have, or a
|
||||||
|
Pull Request. Please keep our [contribution guidelines](https://github.com/polyphony-chat/.github/blob/main/CONTRIBUTION_GUIDELINES.md) in mind. Your contribution might not be
|
||||||
|
accepted, if it violates these guidelines or [our Code of Conduct](https://github.com/polyphony-chat/.github/blob/main/CODE_OF_CONDUCT.md).
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Progress Tracker/Roadmap</summary>
|
||||||
|
|
||||||
### Core Functionality
|
### Core Functionality
|
||||||
- [x] Rate Limiter (hint: couldn't be fully tested due to [an Issue with the Spacebar Server](https://github.com/spacebarchat/server/issues/1022))
|
- [x] Rate Limiter (hint: couldn't be fully tested due to [an Issue with the Spacebar Server](https://github.com/spacebarchat/server/issues/1022))
|
||||||
- [x] [Login (the conventional way)](https://github.com/polyphony-chat/chorus/issues/1)
|
- [x] [Login (the conventional way)](https://github.com/polyphony-chat/chorus/issues/1)
|
||||||
|
@ -121,3 +133,4 @@
|
||||||
[license-url]: https://github.com/polyphony-chat/chorus/blob/master/LICENSE
|
[license-url]: https://github.com/polyphony-chat/chorus/blob/master/LICENSE
|
||||||
[Discord]: https://dcbadge.vercel.app/api/server/m3FpcapGDD?style=flat
|
[Discord]: https://dcbadge.vercel.app/api/server/m3FpcapGDD?style=flat
|
||||||
[Discord-invite]: https://discord.com/invite/m3FpcapGDD
|
[Discord-invite]: https://discord.com/invite/m3FpcapGDD
|
||||||
|
</details>
|
Loading…
Reference in New Issue