commit 9641948447da1b60db2f64b14a7092c3ccaac1f3 parent 4bf5ac2691d446501ac8789d9ac8024e7860198a Author: AsherMorgan <59518073+AsherMorgan@users.noreply.github.com> Date: Mon, 25 Jan 2021 10:43:15 -0800 Update README. Diffstat:
| M | README.md | | | 46 | +++++++++++++++++++++++++++++++++++++++++++++- |
1 file changed, 45 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md @@ -1,7 +1,9 @@ # countdown-bot A Discord bot to facilitate countdowns. -# Setup + + +## Setup 1. Install the Python dependencies ``` pip install -r requirements.txt @@ -24,3 +26,45 @@ A Discord bot to facilitate countdowns. ``` python bot.py ``` + + + +## Behavior +- When a user posts out of turn the bot reacts to the message with ⛔. +- When a user posts an incorrect number the bot reacts to the message with ❌. +- When a user posts a number divisible by 200 the bot pins it. +- When a user posts 0 the bot reacts with 🥳. + + + +## Commands +If a command is not run in a countdown channel, the bot will run it for the 1st countdown channel. + +### contributors +**Description:** Shows information about countdown contributors + +**Usage:** `!countdown contributors|c` + + +### help +**Description:** Shows help information + +**Usage:** `!countdown help [command]` + + +### leaderboard +**Description:** Shows the countdown leaderboard + +**Usage:** `!countdown leaderboard|l [user]` + + +### progress +**Description:** Shows information about countdown progress + +**Usage:** `!countdown progress|p` + + +### reload +**Description:** Reloads the countdown cache + +**Usage:** `!countdown reload`