diff --git a/README.md b/README.md index 7de3b3d..3c590a6 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,18 @@ Бот, генерирующий капчу в виде картинки с набором логотипов игровых движков. Проверяемому необходимо выбрать правильный и написать ответ цифрой. Если ответ неверный: бот банит пользователя. +## Модули + +### Kicker +Сам бот, взаимодействующий с Telegram и базой. Обработчики событий находятся в `handlers.go` + +### DB +Обработчик базы данных, взаимодействует с MongoDB + +### Captchagen +Автономный генератор капчи. При запуске принимает список картинок, которые потом использует для генерации капчи. По умолчанию логотип с именем `godot.png` всегда является правильным. + + ## Как запустить: Создать два файла: `bot.env` и `mongo.env` для настройки базы и самого бота.