Minecraft
/
HypeBot
6
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Fixed README.md

master
Joey Hines 2020-05-19 19:18:13 -05:00
parent 642abf7ccb
commit 6c33d46cb4
1 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,11 +1,29 @@
# HypeBot # HypeBot
A Discord bot for managing events. Uses [Serenity](https://github.com/serenity-rs/serenity) for the bot framework A Discord bot for managing events. Uses [Serenity](https://github.com/serenity-rs/serenity) for the bot framework
and [Disel](http://diesel.rs/) as an ORM. and [Diesel](http://diesel.rs/) as an ORM.
## Usage
Creating an event can be done using the `create` command.
```
~create "Test Event" "5:35PM 2020-05-17" "A very cool test event!" "Cool Place"
```
This creates a draft event that the user can then review:
![create event example]
(https://i.imgur.com/9jTko9W.png)
A user can then using the `confirm` command to create the event and publish it:
![announcment]
(https://i.imgur.com/AeTE1v2.png)
Users who react with ✅ will then be sent reminders about the event as private message.
## Running ## Running
`./hype_bot config.toml` `./hype_bot config.toml`
##Config ## Config
```toml ```toml
# Database URL # Database URL
db_url = "mysql://[user]:[password]@localhost/hypebot_db" db_url = "mysql://[user]:[password]@localhost/hypebot_db"