Add README

This commit is contained in:
Natsu Kagami 2020-02-05 18:02:48 -05:00
parent 84150cd82e
commit dfc8eede73
Signed by: nki
GPG key ID: 73376E117CD20735

17
README.md Normal file
View file

@ -0,0 +1,17 @@
# youmubot
A Discord bot made specifically for server "Dự tuyển Tổng Hợp". Written in Rust.
All PRs welcome.
## Project structure
- `youmubot`: The main command. Collect configurations and dispatch commands.
- `youmubot-prelude`: Base structures and handy functions for command parsing / service handling.
- `youmubot-db`: Base database structures.
- `youmubot-core`: Core commands: admin, fun, community
- `youmubot-osu`: osu!-related commands.
## License
Basically MIT.