diff --git a/README.md b/README.md index c43db20..dc4e049 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,23 @@ -# CheeseBot - REWRITE. +# cheeseBot - REWRITE -This is a work in progress... +cheeseBot is a bot made by Eri/Rei related to stuff about cheese. +Its main function gets triggered whenever it detects a message with a cheese keyword. Users can opt-out of this feature by using the button attached to the DM sent by cheeseBot. + +A server can also opt-out of this feature, by running the command `/server_blacklist`. Be advised that only admins can use this command. + +Other commands from cheeseBot are... + +1. `/cheese` +Sends a cheese wedge (🧀) to the channel. + +2. `/photo` +Sends a cheese photo to the channel. + +3. `/fact` +Sends a cheese fact to the channel. + +4. `/truth` +Sends a phrase that's 100% the truth to the channel (This is a joke). ## License This project is licensed under the [GNU General Public License v3.0](https://spdx.org/licenses/GPL-3.0-or-later.html).