summaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorilotterytea <iltsu@alright.party>2024-05-19 00:16:04 +0500
committerilotterytea <iltsu@alright.party>2024-05-19 00:16:04 +0500
commitecca9314a53b961f49ae57528e30a3a17f5300dc (patch)
treef99110ad90b9798b873c1c9ea4fdfba7aa45c34d /docs/README.md
parent21991b1da2bfab5aa266e7ba91527a6ee62a6b99 (diff)
feat: docs
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..e96a74b
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,34 @@
+# iLotterytea's Twitch bot
+Welcome to iLotterytea's Twitch bot wiki!
+Here you will find useful information about the available commands,
+features, and functions to maximize your enjoyment of interacting with the chat bot.
+
+
+## About iLotterytea's Twitch bot
+iLotterytea's Twitch bot is a smart and feature-rich bot designed specifically for your Twitch channel.
+You can use it to manage your chat, interact with viewers, track stats, and more.
+Just use the commands to have a fun and interactive chat experience!
+
+## How to get started
+
++ **Install the bot**
+
+You can use an instance already running (like [@teabot](https://twitch.tv/teabot) and
+install it in your chat by sending the command [!join](/wiki/join) in its chat,
+or you can self-host it using [these instructions](https://git.ilotterytea.kz/bot/plain/README.md).
+
++ **Basic Commands**
+
+Learn the list of basic commands to quickly start using the bot.
+For example, `!help` for a list of available commands,
+or you can look at the articles under the "Commands" heading on the side bar.
+
++ **Personalization**
+
+Customize the bot to suit your style.
+[Add your unique commands](/wiki/channel/custom-commands) and [customize features](/wiki/channel/settings) as you see fit.
+
+## Updates
+
+The bot is **under active development**.
+Keep an eye on [Git](https://git.ilotterytea.kz/bot) for updates.