From 0ee89fc6077315b8e5ae511de414de5a9fa9c96e Mon Sep 17 00:00:00 2001 From: Xevion Date: Thu, 18 Feb 2021 07:51:37 -0600 Subject: [PATCH] Update README to latest project specifications Still a fair bit more to go, apparently. --- README.md | 47 +++++++++++++++++++++-------------------------- 1 file changed, 21 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 51b9c8f..65136c8 100644 --- a/README.md +++ b/README.md @@ -14,29 +14,21 @@ python main.py ## Commands -Default prefix is `$`, change it as you please. +Default prefix is `$` or by mentioning the bot. Change it with the `prefix` command. ``` -$config prefix PREFIX - Changes the prefix of the bot's commands. - -$config submissions SUBMISSIONS_CHANNEL - Changes the channel moderated for submissions. - -$start submissions [DURATION = -1] [AUTOFORWARD = true] - Starts the submissions period. - -$start voting [DURATION = - 1] - Starts the voting period. - -$stop submissions - Stops the submissions period. - -$stop voting - Stops the voting period. - -$calculate - Calculates and prints a scoreboard of all submissions with the submitting user and a link to their submission. + advance [duration] [pingback = True] + Advance the state of the current period pertaining to this Guild. + close + Closes the current period. + leaderboard + Prints a leaderboard + prefix + Changes the bot's saved prefix. + status + Provides the bot's current state in relation to internal config... + submission + Changes the bot's saved submission channel. ``` ## Features @@ -44,11 +36,14 @@ $calculate - [X] Customizable prefix - [X] Ensure 1-2 char length - [ ] Ensure ASCII -- [ ] Adds upvote reactions automatically to the designated submissions channel -- [ ] Removes regular messages and videos -- [ ] Deletes user's previous submissions if they upload more than one per period. - - [ ] Only tracks submissions per period - previous periods are ignored. +- [X] Adds upvote reactions automatically to the designated submissions channel +- [X] Removes regular messages + - [ ] Remove Videos or Gifs + - [X] Regular Messages +- [X] Deletes user's previous submissions if they upload more than one per period. + - [X] Only tracks submissions per period - previous periods are ignored. - [ ] Removes user's previous reactions if they vote more than once. +- [X] Ignore/remove reactions added to non-submission message in the channel (preserve) - [ ] Calculates the winners automatically. -- [ ] Handles submission removal +- [X] Handles submission removal - [ ] Automatically switches between periods if a duration is specified