From aae478543d41dbd45bde31dd883ffaa4a1d58708 Mon Sep 17 00:00:00 2001 From: Flori Weber Date: Tue, 20 Jun 2023 00:17:52 +0200 Subject: [PATCH] Simplify README --- README.md | 171 +++++++++++++++++++++++++++++------------------------- 1 file changed, 92 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index 279a196..9a75a54 100644 --- a/README.md +++ b/README.md @@ -31,93 +31,106 @@ -## Progress Tracker/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 (the conventional way)](https://github.com/polyphony-chat/chorus/issues/1) -- [ ] [2FA](https://github.com/polyphony-chat/chorus/issues/40) -- [x] [Registration](https://github.com/polyphony-chat/chorus/issues/1) +## About -### Messaging -- [x] [Sending messages](https://github.com/polyphony-chat/chorus/issues/23) -- [x] [Events (Message, User, Channel, etc.)](https://github.com/polyphony-chat/chorus/issues/51) -- [x] Channel creation -- [x] Channel deletion -- [x] [Channel management (name, description, icon, etc.)](https://github.com/polyphony-chat/chorus/issues/48) -- [ ] [Join and Leave Guilds](https://github.com/polyphony-chat/chorus/issues/45) -- [ ] [Start DMs](https://github.com/polyphony-chat/chorus/issues/45) -- [ ] [Group DM creation, deletion and member management](https://github.com/polyphony-chat/chorus/issues/89) -- [ ] [Deleting messages](https://github.com/polyphony-chat/chorus/issues/91) -- [ ] [Message threads](https://github.com/polyphony-chat/chorus/issues/90) -- [x] [Reactions](https://github.com/polyphony-chat/chorus/issues/85) -- [ ] Message Search -- [ ] Message history -- [ ] Emoji -- [ ] Stickers -- [ ] [Forum channels](https://github.com/polyphony-chat/chorus/issues/90) +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. -### User Management -- [ ] [User profile customization](https://github.com/polyphony-chat/chorus/issues/41) -- [x] Gettings users and user profiles -- [x] [Friend requests](https://github.com/polyphony-chat/chorus/issues/92) -- [x] [Blocking users](https://github.com/polyphony-chat/chorus/issues/92) -- [ ] User presence (online, offline, idle, etc.) -- [ ] User status (custom status, etc.) -- [x] Account deletion +## Contributing -### Additional Features -- [ ] Server discovery -- [ ] Server templates +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). -### Voice and Video -- [ ] [Voice chat support](https://github.com/polyphony-chat/chorus/issues/49) -- [ ] [Video chat support](https://github.com/polyphony-chat/chorus/issues/49) +
+ Progress Tracker/Roadmap -### Permissions and Roles -- [x] [Role management](https://github.com/polyphony-chat/chorus/issues/46) (creation, deletion, modification) -- [x] [Permission management](https://github.com/polyphony-chat/chorus/issues/46) (assigning and revoking permissions) -- [x] [Channel-specific permissions](https://github.com/polyphony-chat/chorus/issues/88) -- [x] Role-based access control + ### 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 (the conventional way)](https://github.com/polyphony-chat/chorus/issues/1) + - [ ] [2FA](https://github.com/polyphony-chat/chorus/issues/40) + - [x] [Registration](https://github.com/polyphony-chat/chorus/issues/1) -### Guild Management -- [x] Guild creation -- [x] Guild deletion -- [ ] [Guild settings (name, description, icon, etc.)](https://github.com/polyphony-chat/chorus/issues/43) -- [ ] Guild invites + ### Messaging + - [x] [Sending messages](https://github.com/polyphony-chat/chorus/issues/23) + - [x] [Events (Message, User, Channel, etc.)](https://github.com/polyphony-chat/chorus/issues/51) + - [x] Channel creation + - [x] Channel deletion + - [x] [Channel management (name, description, icon, etc.)](https://github.com/polyphony-chat/chorus/issues/48) + - [ ] [Join and Leave Guilds](https://github.com/polyphony-chat/chorus/issues/45) + - [ ] [Start DMs](https://github.com/polyphony-chat/chorus/issues/45) + - [ ] [Group DM creation, deletion and member management](https://github.com/polyphony-chat/chorus/issues/89) + - [ ] [Deleting messages](https://github.com/polyphony-chat/chorus/issues/91) + - [ ] [Message threads](https://github.com/polyphony-chat/chorus/issues/90) + - [x] [Reactions](https://github.com/polyphony-chat/chorus/issues/85) + - [ ] Message Search + - [ ] Message history + - [ ] Emoji + - [ ] Stickers + - [ ] [Forum channels](https://github.com/polyphony-chat/chorus/issues/90) -### Moderation -- [ ] Channel moderation (slow mode, etc.) -- [ ] User sanctions (mute, kick, ban) -- [ ] Audit logs + ### User Management + - [ ] [User profile customization](https://github.com/polyphony-chat/chorus/issues/41) + - [x] Gettings users and user profiles + - [x] [Friend requests](https://github.com/polyphony-chat/chorus/issues/92) + - [x] [Blocking users](https://github.com/polyphony-chat/chorus/issues/92) + - [ ] User presence (online, offline, idle, etc.) + - [ ] User status (custom status, etc.) + - [x] Account deletion -### Embeds and Rich Content -- [x] Sending rich content in messages (links, images, videos) -- [ ] Customizing embed appearance (title, description, color, fields) + ### Additional Features + - [ ] Server discovery + - [ ] Server templates -### Webhooks -- [ ] Webhook creation and management -- [ ] Handling incoming webhook events + ### Voice and Video + - [ ] [Voice chat support](https://github.com/polyphony-chat/chorus/issues/49) + - [ ] [Video chat support](https://github.com/polyphony-chat/chorus/issues/49) -### Documentation and Examples -- [ ] Comprehensive documentation -- [ ] Example usage and code snippets -- [ ] Tutorials and guides + ### Permissions and Roles + - [x] [Role management](https://github.com/polyphony-chat/chorus/issues/46) (creation, deletion, modification) + - [x] [Permission management](https://github.com/polyphony-chat/chorus/issues/46) (assigning and revoking permissions) + - [x] [Channel-specific permissions](https://github.com/polyphony-chat/chorus/issues/88) + - [x] Role-based access control -[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/build_and_test.yml?style=flat -[build-url]: https://github.com/polyphony-chat/chorus/blob/main/.github/workflows/build_and_test.yml -[clippy-shield]: https://img.shields.io/github/actions/workflow/status/polyphony-chat/chorus/clippy.yml?style=flat -[clippy-url]: https://github.com/polyphony-chat/chorus/blob/main/.github/workflows/clippy.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 + ### Guild Management + - [x] Guild creation + - [x] Guild deletion + - [ ] [Guild settings (name, description, icon, etc.)](https://github.com/polyphony-chat/chorus/issues/43) + - [ ] Guild invites + + ### Moderation + - [ ] Channel moderation (slow mode, etc.) + - [ ] User sanctions (mute, kick, ban) + - [ ] Audit logs + + ### Embeds and Rich Content + - [x] Sending rich content in messages (links, images, videos) + - [ ] Customizing embed appearance (title, description, color, fields) + + ### Webhooks + - [ ] Webhook creation and management + - [ ] Handling incoming webhook events + + ### Documentation and Examples + - [ ] Comprehensive documentation + - [ ] Example usage and code snippets + - [ ] Tutorials and guides + + [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/build_and_test.yml?style=flat + [build-url]: https://github.com/polyphony-chat/chorus/blob/main/.github/workflows/build_and_test.yml + [clippy-shield]: https://img.shields.io/github/actions/workflow/status/polyphony-chat/chorus/clippy.yml?style=flat + [clippy-url]: https://github.com/polyphony-chat/chorus/blob/main/.github/workflows/clippy.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 +
\ No newline at end of file