feat: docs

2 files changed, 185 insertions, 0 deletions

diff --git a/docs/stream/events.md b/docs/stream/events.md
new file mode 100644
index 0000000..d9db6d6
--- /dev/null
+++ b/docs/stream/events.md
@@ -0,0 +1,108 @@
+# Stream events
+
+> This command is for broadcaster only.
+
+
+The `!event` command gives broadcasters the ability to manage events for streams.
+
+
+## Event types
+
++ live
++ offline
++ title
++ category
++ custom
+
+## Event flags
+
++ `massping` - Massping everyone in chat regardless of their subscription to the event.
+
+## Syntax
+
+### Create a new event
+
+`!event on [name]:[type] [message...]`
+
++ `[name]` - Twitch username or event name *(custom type only)*.
++ `[type]` - [Event type](#event-types).
++ `[message]` - The message that will be sent with the event.
+
+
+> Events with types *category* and *title* use *{0}* and *{1}* placeholders
+> for old and new values respectively.
+> This means that the bot can show changes if you set them
+> (e.g. *forsen changed the title from **{0}** to **{1}*** will replace
+> with *forsen changed the title from **Just Chatting** to **PUBG***).
+
+
+### Delete the event
+
+`!event off [name]:[type]`
+
++ `[name]` - Twitch username or event name *(custom type only)*.
++ `[type]` - [Event type](#event-types).
+
+### Flag/unflag the event
+
+`!event flag [name]:[type] [flag]`
+
++ `[name]` - Twitch username or event name *(custom type only)*.
++ `[type]` - [Event type](#event-types).
++ `[flag]` - [Event flag](#event-flags).
+
+### Call the event
+
+
+> The bot requires moderator privileges on events with the **"massping"** flag.
+
+
+`!event call [name]:[type]`
+
++ `[name]` - Twitch username or event name *(custom type only)*.
++ `[type]` - [Event type](#event-types).
+
+## Usage
+
+### Creating a new event
++ `!event on forsen:live forsen live!`
+
+### Deleting the event
++ `!event off forsen:live`
+
+### Flag/unflag the event
++ `!event flag forsen:live massping`
+
+### Calling the event
++ `!event call forsen:live`
+
+## Responses
+
+### Creating a new event
++ `A new "forsen:live" event has been successfully created! It will send a message when the event occurs.`
+
+### Deleting the event
++ `The "forsen:live" (ID ...) event has been successfully deleted!`
+
+### Adding the flag to the event
++ `Flag "massping" is set for the "forsen:live" event.`
+
+### Removing the flag from the event
++ `Flag "massping" has been removed from the "forsen:live" event.`
+
+### Calling the event
++ `⚡ forsen live!` 
+
+## Important notes
+
++ If the specified event name does not belong to a Twitch user,
+the event type will automatically be considered ***custom***.
+
+## Error handling
+
++ [Not enough arguments](/wiki/errors#0)
++ [Incorrect argument](/wiki/errors#2)
++ [Insufficient rights](/wiki/errors#3)
++ [Namesake creation](/wiki/errors#11)
++ [Not found](/wiki/errors#12)
++ [Something went wrong](/wiki/errors#127)
diff --git a/docs/stream/notifications.md b/docs/stream/notifications.md
new file mode 100644
index 0000000..7be6f0c
--- /dev/null
+++ b/docs/stream/notifications.md
@@ -0,0 +1,77 @@
+# Stream notifications
+
+The `!notify` command gives users the ability to manage event subscriptions.
+
+## Syntax
+
+### Subscribe to the event
+`!notify sub [name]:[type]`
+
++ `[name]` - Twitch username or event name *(custom type only)*.
++ `[type]` - [Event type](/wiki/stream/events#event-types).
+
+### Unsubscribe from the event
+`!notify unsub [name]:[type]`
+
++ `[name]` - Twitch username or event name *(custom type only)*.
++ `[type]` - [Event type](/wiki/stream/events#event-types).
+
+### Get your event subscriptions
+`!notify subs`
+
+### Get available events to subscribe
+`!notify list`
+
+## Usage
+
+### Subscribing to the event
+
++ `!notify sub forsen:live`
+
+### Unsubscribing from the event
+
++ `!notify unsub forsen:live`
+
+## Responses
+
+### Subscribing to the event
+
++ If you're not a subscriber
+
+`You have successfully subscribed to the "forsen:live" event!`
+
++ If you're already a subscriber
+
+`You're already a subscriber to the "forsen:live" event.`
+
+### Unsubscribing from the event
+
++ If you're not a subscriber
+
+`You're not subscribed to the "forsen:live" event.`
+
++ If you're a subscriber
+
+`You have successfully unsubscribed from the "forsen:live" event!`
+
+### Getting event subscriptions
+
++ If you're subscribed to at least one event
+
+`Your subscriptions: forsen:live, xqc:offline, nymn:title, ...`
+
++ Otherwise,
+
+`You're not subscribed to any events.`
+
+## Important notes
+
++ If the specified event name does not belong to a Twitch user, 
+the event type will automatically be considered ***custom***.
+
+## Error handling
+
++ [Not enough arguments](/wiki/errors#0)
++ [Incorrect argument](/wiki/errors#2)
++ [Not found](/wiki/errors#12)
++ [Something went wrong](/wiki/errors#127)