chorus/README.md

44 lines
1.9 KiB
Markdown

# chorus
[![Rust]][Rust-url]
[![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]
A rust library for interacting with multiple Spacebar-compatible APIs and Gateways at the same time.
## Roadmap
Core functionality:
- [ ] Rate Limiter
- [ ] Login
- [ ] Registration
- [ ] User profile customisation
- [ ] Receiving messages
- [ ] Deleting messages
- [ ] Sending messages (Text, Images, Attachments)
- [ ] Sending and receiving emoji
- [ ] Sending and receiving 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=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