readme update

This commit is contained in:
fluttershy 2025-01-20 15:01:44 +05:00
parent e0c7c1fcd1
commit fd81f46315

View File

@ -1,20 +1,27 @@
# Sparkle
Library for creating discord bots
# ToDo
- [x] Websocket support
- [x] Minimal discord api support
- [x] Selfbot support
- [x] Easy to use
- [ ] Support json extraction from server response
- [ ] Optimised for high loads
- [ ] Full api support
- [ ] Fixes for known bugs
- [ ] Windows support
- [ ] Sharding
# How to build
Library for creating Discord bots.
## How to Build
### Required Libraries
- `curl`
- `ixwebsocket`
### Build Instructions
```sh
git clone http://applejack.ygg/fluttershy/sparkle.git
mkdir sparkle/build && cd sparkle/build
cmake .. && make -j$(nproc)
./sparkle -t <BOT_TOKEN>
```
# ToDo
- [x] Websocket support
- [x] Minimal discord api support
- [x] Selfbot support
- [x] Easy to use
- [x] Support json extraction from server response
- [ ] Optimised for high loads (not tested)
- [ ] Full api support
- [ ] Fixes for known bugs
- [ ] Windows support
- [ ] Sharding