aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJokler <jokler@protonmail.com>2020-03-22 20:29:31 +0100
committerGitHub <noreply@github.com>2020-03-22 20:29:31 +0100
commit6fa137726286edaebd60835b9a5e05a13135d313 (patch)
tree448a580a21f09e5b7bf6eed18241392d6720c820
parentede6ee22b74e62572e32a9bac357c7b29ead2800 (diff)
parentb54d4aa954f58a44938e55678dd5ea78a6d9d22f (diff)
downloadpokebot-6fa137726286edaebd60835b9a5e05a13135d313.tar.gz
pokebot-6fa137726286edaebd60835b9a5e05a13135d313.zip
Merge pull request #50 from TheGreatestJannet/UsageInstructions
Add Usage instructions to ReadMe
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 86d0591..0454203 100644
--- a/README.md
+++ b/README.md
@@ -21,3 +21,22 @@ OPTIONS:
ARGS:
<config_path> Configuration file [default: config.toml]
```
+# Usage
+
+ 1. Poke the main bot.
+ 2. Once the secondary bot joins your channel, type !help for a list of commands.
+
+ **Chat commands:**
+ ```
+ add Adds url to playlist
+ clear Clears the playback queue
+ help Prints this message or the help of the given subcommand(s)
+ leave Leaves the channel
+ next Switches to the next queue entry
+ pause Pauses audio playback
+ play Starts audio playback
+ search Adds the first video found on YouTube
+ seek Seeks by a specified amount
+ stop Stops audio playback
+ volume Changes the volume to the specified value
+ ```