From 762131db61177024938313c85b1c982bbbae3097 Mon Sep 17 00:00:00 2001
From: Vlad Rud <nefrace@gmail.com>
Date: Wed, 2 Feb 2022 12:55:05 +0300
Subject: [PATCH] Create README.md

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7de3b3d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# KickerBot
+
+Бот, генерирующий капчу в виде картинки с набором логотипов игровых движков. Проверяемому необходимо выбрать правильный и написать ответ цифрой. Если ответ неверный: бот банит пользователя.
+
+## Как запустить:
+Создать два файла: `bot.env` и `mongo.env` для настройки базы и самого бота.
+
+**bot.env**
+```
+TOKEN=<токен бота Telegram>
+DB_USER=<логин для базы>
+DB_PASSWORD=<пароль для базы>
+MONGO_URI=mongodb://mongo:27017
+```
+
+**mongo.env**
+```
+MONGO_INITDB_ROOT_USERNAME=<логин для базы>
+MONGO_INITDB_ROOT_PASSWORD=<пароль для базы>
+
+ME_CONFIG_MONGODB_ADMINUSERNAME=<логин для базы>
+ME_CONFIG_MONGODB_ADMINPASSWORD=<пароль для базы>
+ME_CONFIG_MONGODB_URL=mongodb://<логин>:<пароль>@mongo:27017/
+```
+
+Затем запустить команду `docker-compose up -d --build`, чтобы собрать образ бота и запустить контейнеры в стэке.