feat: docs

3 files changed, 271 insertions, 0 deletions

diff --git a/docs/channel/custom-commands.md b/docs/channel/custom-commands.md
new file mode 100644
index 0000000..9568919
--- /dev/null
+++ b/docs/channel/custom-commands.md
@@ -0,0 +1,90 @@
+# Custom commands
+
+> This command is for broadcaster only
+
+
+The `!cmd` command gives broadcasters the ability to create their own chat commands.
+
+
+## Syntax
+
+
+### Create a new custom command
+
+`!cmd new [name] [message...]`
+
++ `[name]` - The name for new custom command. It should be unique for your chat. 
+A prefix must be specified if you want a prefixed command, e.g. `!sub`, `!server`.
++ `[message]` - Text that will be sent when the custom command is invoked.
+
+### Delete the custom command
+
+`!cmd delete [name]`
+
++ `[name]` - Name of custom command.
+
+### Edit the message for custom command
+`!cmd message [name] [message...]`
+
++ `[name]` - Name of custom command.
++ `[message]` - Text with which to replace
+
+### Toggle (enable/disable) the custom command
+`!cmd toggle [name]`
+
++ `[name]` - Name of custom command.
+
+### Check the information about custom command
+`!cmd info [name]`
+
++ `[name]` - Name of custom command
+
+### Get the list of created custom commands
+`!cmd list`
+
+## Usage
+
+### Creating a new custom command
++ `!cmd new !sub Buy a Twitch sub at this link and become like the rest of us 😎`
+
+### Deleting the custom command
++ `!cmd delete !sub`
+
+### Editing the message for custom command
++ `!cmd message !sub Buy a Prime sub at this link and become like the rest of us 😎`
+
+### Toggling the custom command
++ `!cmd toggle !sub`
+
+### Checking the information about the custom command
++ `!cmd info !sub`
+
+## Responses
+
+### Creating a new custom command
++ `A new custom command with "!sub" name has been successfully created!`
+
+### Deleting the custom command
++ `The "!sub" (ID ...) custom command has been deleted!`
+
+### Editing the message for custom command
++ `The message for "!sub" (ID ...) custom command has been changed!`
+
+### Toggling the custom command
++ If the command was enabled
+
+`The "!sub" (ID ...) custom command has been disabled!`
+
++ If the command was disabled
+
+`The "!sub" (ID ...) custom command has been enabled!`
+
+### Checking the information about the custom command
++ `✅ !sub (ID ...) | Message: Buy a Prime sub at this link and become like the rest of us 😎`
+
+## Error handling
+
++ [Not enough arguments](/wiki/errors#0)
++ [Namesake creation](/wiki/errors#11)
++ [Not found](/wiki/errors#12)
++ [Something went wrong](/wiki/errors#127)
diff --git a/docs/channel/settings.md b/docs/channel/settings.md
new file mode 100644
index 0000000..1f25d32
--- /dev/null
+++ b/docs/channel/settings.md
@@ -0,0 +1,69 @@
+# Settings
+
+> This command is for broadcaster only.
+
+
+The `!set` command gives broadcasters ability to customize the bot as they need it to be more fitted for chat.
+
+
+## Available features
+
++ `notify_7tv_updates` - Enable notifications for changes to the channel's 7TV emote set.
+
+## Syntax
+
+### Set the bot localization for the chat
+`!set locale [lang]`
+
++ `[lang]` - Language name in English and lowercase. 
+Available languages at the moment: **english**, **russian**.
+
+### Set the bot prefix
+`!set prefix [characters]`
+
++ `[characters]` - Characters to be set as a prefix.
+
+### Enable/disable the bot feature for the chat
+`!set feature [feature]`
+
++ `[feature]` - [Available features](#available-features)
+
+## Usage
+
+### Setting the bot localization
+
++ `!set locale russian`
++ `!set locale english`
+
+### Setting the bot prefix
+
++ `!set prefix ~`
++ `!set prefix ?!`
+
+### Enabling/disabling the bot feature
+
++ `!set feature notify_7tv_updates`
+
+## Responses
+
+### Setting the bot localization
+
++ `Успешно установил язык чата на русский!`
++ `Successfully set the chat language to English!`
+
+### Setting the bot prefix
+
++ `Successfully set the chat prefix to "~"`
++ `Successfully set the chat prefix to "?!"`
+
+### Enabling/disabling the bot feature
+
++ `Successfully enabled the "notify_7tv_updates" feature for this chat!`
++ `Successfully disabled the "notify_7tv_updates" feature for this chat!`
+
+## Error handling
+
++ [Not enough arguments](/wiki/errors#0)
++ [Incorrect argument](/wiki/errors#2)
++ [Not found](/wiki/errors#12)
++ [Something went wrong](/wiki/errors#127)
diff --git a/docs/channel/timer.md b/docs/channel/timer.md
new file mode 100644
index 0000000..df72427
--- /dev/null
+++ b/docs/channel/timer.md
@@ -0,0 +1,112 @@
+# Timers
+
+> This command is for broadcaster only
+
+
+The `!timer` command gives broadcasters the ability to create timers that sends messages to the chat room every specified interval.
+
+
+## Syntax
+
+### Create a new timer
+`!timer new [name] [interval] [message...]`
+
++ `[name]` - The name for new timer. It should be unique for your chat.
++ `[interval]` - Message sending interval *(in seconds)*.
++ `[message]` - Text that will be sent after the interval has passed.
+
+### Delete the timer
+`!timer delete [name]`
+
++ `[name]` - The name of the timer.
+
+### Edit the message for the timer
+`!timer message [name] [message...]`
+
++ `[name]` - The name of the timer.
++ `[message]` - Text with which to replace.
+
+### Edit the interval for the timer
+`!timer interval [name] [interval]`
+
++ `[name]` - The name of the timer.
++ `[interval]` - An interval *(in seconds)* with which to replace.
+
+### Toggle (enable/disable) the timer
+`!timer toggle [name]`
+
++ `[name]` - The name of the timer.
+
+### Check the information about the timer
+`!timer info [name]`
+
++ `[name]` - The name of the timer.
+
+### Call the timer
+`!timer call [name]`
+
++ `[name]` - The name of the timer.
+
+### Get the list of created timers
+`!timer list`
+
+## Usage
+
+### Creating a new timer
++ `!timer new sub_ads 120 Buy a Twitch sub and be like all of us`
+
+### Deleting the timer
++ `!timer delete sub_ads`
+
+### Editing the message for the timer
++ `!timer message sub_ads Buy a Prime sub and be like all of us `
+
+### Editing the interval for the timer
++ `!timer interval sub_ads 180`
+
+### Toggling the timer
++ `!timer toggle sub_ads`
+
+### Checking the information about the timer
++ `!timer info sub_ads`
+
+### Calling the timer
++ `!timer call sub_ads`
+
+
+## Responses
+
+### Creating a new timer
++ `A new timer with "sub_ads" name has been successfully created!`
+
+### Deleting the timer
++ `The "sub_ads" (ID ...) timer has been deleted!`
+
+### Editing the message for the timer
++ `The message for "sub_ads" (ID ...) timer has been changed!`
+
+### Editing the interval for the timer
++ `The interval for "sub_ads" (ID ...) timer has been changed!`
+
+### Toggling the timer
++ If the timer was enabled
+
+`The "sub_ads" (ID ...) timer has been disabled!` 
+
++ If the timer was disabled
+
+`The "sub_ads" (ID ...) timer has been enabled!`
+
+### Checking the information about the timer
++ `✅ sub_ads (ID ...) | Interval: 120s | Message: Buy a Twitch sub and be like all of us`
+
+### Calling the timer
++ `Buy a Twitch sub and be like all of us` 
+
+## Error handling
+
++ [Not enough arguments](/wiki/errors#0)
++ [Incorrect argument](/wiki/errors#2)
++ [Namesake creation](/wiki/errors#11)
++ [Not found](/wiki/errors#12)
++ [Something went wrong](/wiki/errors#127)