diff --git a/README.md b/README.md index d45a992..0839dfe 100644 --- a/README.md +++ b/README.md @@ -26,3 +26,53 @@ To run the bot simply execute ``main.py``: ```sh ./main.py ``` + +## Commands +### Basic +#### `/sayhello` +Prints ``Hello world!`` + +#### `/ping` +Shows the bot's latency. + +### Messages +#### `/set_forward_channel <#channel>` +Sets channel to forward messages to. + +#### `>forward` +Forwards message to set channel + +### Roles +#### `/secretroles` +Manages roles locked behind a password. + +Lock ``@role`` behind a password ``supersecret``: +``` +/secretroles add @role supersecret +``` + +Delete password ``supersecret``, so role is no longer obtainable with it: +``` +/secretroles delete supersecret +``` + +List all current passwords and their roles: +``` +/secretroles list +``` + +### KSP +Ksp related commands + +#### `/task` +Generates urls for given task. + +#### `/deadlines` +Shows deadlines of currently running series. + +### News +#### `/news set_channel <#channel>` +Set channel for posting news. + +#### `/news post_news ` +Post news with given `id` to set channel.