69 lines
3.0 KiB
Markdown
69 lines
3.0 KiB
Markdown
<div align="center">
|
|
|
|
[![Discord]][Discord-invite]
|
|
[![Build][build-shield]][build-url]
|
|
[![Contributors][contributors-shield]][contributors-url]
|
|
[![Forks][forks-shield]][forks-url]
|
|
[![Issues][issues-shield]][issues-url]
|
|
|
|
</br>
|
|
<div align="center">
|
|
<a href="https://github.com/polyphony-chat/chorus">
|
|
<img src="images/polyphony-chorus-round.png" alt="Logo" width="128" height="128">
|
|
</a>
|
|
|
|
<h3 align="center">Chorus</h3>
|
|
|
|
<p align="center">
|
|
A rust library for interacting with (multiple) Spacebar-compatible APIs and Gateways (at the same time).
|
|
<br />
|
|
<a href="https://github.com/polyphony-chat/chorus"><strong>Explore the docs »</strong></a>
|
|
<br />
|
|
<br />
|
|
<a href="https://github.com/polyphony-chat/chorus/issues">Report Bug</a>
|
|
·
|
|
<a href="https://github.com/polyphony-chat/chorus/issues">Request Feature</a>
|
|
·
|
|
<a href="https://discord.gg/8tKSC8wzDq">Join Discord</a>
|
|
</p>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
## Roadmap
|
|
|
|
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] Login (conventional way) (Guess what? Found [an Issue with the Spacebar Server](https://github.com/spacebarchat/server/pull/1043) :3)
|
|
- [ ] 2FA
|
|
- [x] Registration (encountered another [Issue with the Spacebar Server](https://github.com/spacebarchat/server/issues/1040) which makes some error messages an empty string)
|
|
- [x] Gateway Events, multithreaded
|
|
- [x] Sending messages (Text, Images, Attachments)
|
|
- [x] Events (Message, User, Channel, etc.)
|
|
- [ ] Adding, deleting and editing channels
|
|
- [ ] User profile customization
|
|
- [ ] Deleting messages
|
|
- [ ] Emoji
|
|
- [ ] Stickers
|
|
- [ ] Listing users and user profiles
|
|
- [ ] Message threads
|
|
- [ ] Forum channels
|
|
|
|
[Rust]: https://img.shields.io/badge/Rust-orange?style=plastic&logo=rust
|
|
[Rust-url]: https://www.rust-lang.org/
|
|
[build-shield]: https://img.shields.io/github/actions/workflow/status/polyphony-chat/chorus/rust.yml?style=flat
|
|
[build-url]: https://github.com/polyphony-chat/chorus/blob/main/.github/workflows/rust.yml
|
|
[contributors-shield]: https://img.shields.io/github/contributors/polyphony-chat/chorus.svg?style=flat
|
|
[contributors-url]: https://github.com/polyphony-chat/chorus/graphs/contributors
|
|
[forks-shield]: https://img.shields.io/github/forks/polyphony-chat/chorus.svg?style=flat
|
|
[forks-url]: https://github.com/polyphony-chat/chorus/network/members
|
|
[stars-shield]: https://img.shields.io/github/stars/polyphony-chat/chorus.svg?style=flat
|
|
[stars-url]: https://github.com/polyphony-chat/chorus/stargazers
|
|
[issues-shield]: https://img.shields.io/github/issues/polyphony-chat/chorus.svg?style=flat
|
|
[issues-url]: https://github.com/polyphony-chat/chorus/issues
|
|
[license-shield]: https://img.shields.io/github/license/polyphony-chat/chorus.svg?style=f;at
|
|
[license-url]: https://github.com/polyphony-chat/chorus/blob/master/LICENSE
|
|
[Discord]: https://dcbadge.vercel.app/api/server/m3FpcapGDD?style=flat
|
|
[Discord-invite]: https://discord.com/invite/m3FpcapGDD
|