From 2ab033d4a76a98b60c778696918a846d76955065 Mon Sep 17 00:00:00 2001
From: gpkvt <gpkvt@protonmail.com>
Date: Thu, 25 Aug 2022 20:56:51 +0200
Subject: [PATCH] Updated README.md

---
 README.md | 108 ++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 97 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index b363871..0abddc0 100644
--- a/README.md
+++ b/README.md
@@ -192,15 +192,98 @@ Additional commands (broadcaster and mods only) are:
 
 #### !quickvote
 
-The `!quickvote` feature implements a simple vote system. If a broadcaster or moderator send the `!quickvote` command a vote will be started (or a already running vote will be ended). After a quickvote has been started your community can casts votes by sending a chat message starting with `#`. You can include a message after `!quickvote` (e.g. `!quickvote Is pizza hawaii any good? #yes/#no`). If you do so, this message will be repeated every 60 seconds, so everyone keeps in mind, that a vote is still active.
+A simple vote system.
+
+**Usage:**
+
+Start (only Broadcaster/Mods): `!quickvote <message>`
+User: `#choice`
+End (only Broadcaster/Mods): `!quickvote`
+
+**Example:**
+
+``` lang=text
+mod: !quickvote Is pizza hawaii any good? #yes/#no
+chat: #no
+mod: !quickvote
+bot: The result is: #no
+```
+
+If a message is given by the Mods it will be repeated every 60 seconds, so everyone keeps in mind, that a vote is still active.
+
+#### !pick
+
+Randomly choose users from chat (who wants to participate).
+
+**Usage:**
+
+Start (only Broadcaster/Mods): `!pick <int>`
+User: #pickme
+End (only Broadcaster/Mods): `!pick`
+
+**Example:**
+
+``` lang=text
+mod: !pick 3
+user1: #pickme
+user2: #pickme
+user3: #pickme
+user4: #pickme
+user5: #pickme
+mod: !pick
+bot: The picked users are: user5, user3, user1
+```
 
 #### !random
 
-The `!random` command will read a random line from a file called `random.txt`. You can also use multiple files, if you call `!random foo` the bot fetch the random line from a file called `random_foo.txt` instead of `random.txt`. `!random bar` will use the file `random_bar.txt` and so on. The `!random` command is restricted to the broadcaster and moderators.
+Picks a random line from a file.
 
-#### !smartquote
+**Usage:**
 
-The `!smartquote` command will read a line from a file called `quotes.txt`. You can add a parameter after the command. If the parameter is numeric the bot will search for a line starting with `#$number`. If the parameter is a string it will search for a line matching the parameter. If no parameter is given it will search for a completely random line.
+Broadcaster/Mod: `!random <file>`
+
+You can use multiple files, if you call `!random foo` the bot fetch the random line from a file called `random_foo.txt`, `!random bar` will use the file `random_bar.txt` and so on. If no `<file>` is given the command use the file `random.txt`.
+
+**Example:**
+
+``` lang=text
+mod: !random
+bot: This is a random message
+```
+
+#### !addquote
+
+The `!addquote` command adds a new line to `quotes.txt`.
+
+**Usage:**
+
+Chat: `!addquote <username> <quote>`
+
+**Example:**
+
+``` lang=text
+chat: !addquote gpkvt This is a very funny quote.
+bot: Quote #1 was added.
+```
+
+#### !smartquote / !squote
+
+Picks a random/specific line from `quotes.txt`.
+
+**Usage:**
+
+Chat: `!smartquote <linenumber> <searchstring>`
+
+**Example:**
+
+``` lang=text
+chat: !smartquote
+bot: This is a random quote
+chat: !smartquote 1000
+bot: This is quote #1000
+chat: !smartquote something stupid
+bot: This is a quote containing something stupid (or similiar)
+```
 
 The format of `quotes.txt` looks as follows:
 
@@ -208,17 +291,20 @@ The format of `quotes.txt` looks as follows:
 #1: "the quote" -username/game (date)
 ```
 
-#### !addquote
-
-The `!addquote` command adds a new line to `quotes.txt`. It expects two parameters: `!addquote username quote` where `username` is the name of the user to be quoted.
-
 #### !wiki
 
-The `!wiki` command searchs the wikipedia and fetches the first three sentences of the result.
+Search the Wikipedia.
 
-#### !pick
+**Usage:**
 
-The `!pick` command will randomly pick a given number of participants. After `!pick <max number of participants>` was started by the broadcaster or a moderator, everyone can type `#pickme` to become the chance to get picked when `!pick` gets triggered again. If no number was given, when `!pick` was frist triggered only one participant will get picked.
+Chat: `!wiki <searchstring>`
+
+**Example:**
+
+``` lang=text
+chat: !wiki 42 number
+bot: 42 is the "Answer to the Ultimate Question of Life, the Universe, and Everything".
+```
 
 ## Build