chorus/README.md

64 lines
2.5 KiB
Markdown
Raw Normal View History

2023-04-15 18:33:17 +02:00
<div align="center">
2023-04-10 21:28:22 +02:00
2023-04-10 21:31:33 +02:00
[![Rust]][Rust-url]
2023-04-10 21:37:27 +02:00
[![Build][build-shield]][build-url]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![GPL3 License][license-shield]][license-url]
2023-04-10 21:31:40 +02:00
2023-04-15 18:33:17 +02:00
</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>
</p>
</div>
</div>
2023-04-10 21:28:22 +02:00
## 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))
2023-04-10 21:28:22 +02:00
- [ ] Login
2023-04-22 22:56:51 +02:00
- [x] Registration
2023-04-11 18:18:24 +02:00
- [ ] Sending messages (Text, Images, Attachments)
- [ ] Events (Message, User, Channel, etc.)
2023-04-12 21:31:09 +02:00
- [ ] User profile customization
2023-04-10 21:28:22 +02:00
- [ ] Deleting messages
2023-04-11 18:18:24 +02:00
- [ ] Emoji
- [ ] Stickers
2023-04-10 21:28:22 +02:00
- [ ] Listing users and user profiles
- [ ] Message threads
- [ ] Forum channels
2023-04-10 21:31:33 +02:00
[Rust]: https://img.shields.io/badge/Rust-orange?style=plastic&logo=rust
[Rust-url]: https://www.rust-lang.org/
2023-04-10 21:37:05 +02:00
[build-shield]: https://img.shields.io/github/actions/workflow/status/polyphony-chat/chorus/rust.yml?style=plastic
[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=plastic
[contributors-url]: https://github.com/polyphony-chat/chorus/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/polyphony-chat/chorus.svg?style=plastic
[forks-url]: https://github.com/polyphony-chat/chorus/network/members
[stars-shield]: https://img.shields.io/github/stars/polyphony-chat/chorus.svg?style=plastic
[stars-url]: https://github.com/polyphony-chat/chorus/stargazers
[issues-shield]: https://img.shields.io/github/issues/polyphony-chat/chorus.svg?style=plastic
[issues-url]: https://github.com/polyphony-chat/chorus/issues
[license-shield]: https://img.shields.io/github/license/polyphony-chat/chorus.svg?style=plastic
[license-url]: https://github.com/polyphony-chat/chorus/blob/master/LICENSE