Merge branch 'main' of https://github.com/DanyaSWorlD/midpass_auto_queue

README.md

@@ -1 +1,34 @@
-# MidpassAutoQueue
+# Описание проекта
+Это бот для автоматического подтверждения очереди на сайте q.midpass.ru
+## Возможности
+ - Ежедневное подтверждение очереди
+ - Автоматическое прохождение капчи используя сервис [2Captcha](https://2captcha.com/?from=22149884)
+ - Оповещение в телеграмме
+ - Оповещение о месте в очереди
+ - Запрос пароля в тг, если он сменился
+
+## Быстрый старт
+```
+git clone https://github.com/DanyaSWorlD/midpass_auto_queue.git
+```
+Заполнить файл `docker-compose.yml.example` своими данными и переименовать его в `docker-compose.yml`
+```
+docker-compose up -d
+```
+## Конфигурация
+| Ключ     | Описание                                                                                |
+| -------- | --------------------------------------------------------------------------------------- |
+| TG_TOKEN | Токен бота в телеграм. Для получения нужно написать [BotFather](https://t.me/BotFather) |
+| TG_USER  | Ваш айди в телеграмме. Бот будет писать и принимать сообщения только от вас! Для получения ID нужно написать [ID Bot](https://t.me/username_to_id_bot) |
+| EMAIL    | Почта для входа на q.midpass.ru |
+| PASS     | Пароль от сайта |
+| COUNTRY  | Страна. Обязательно полное совпадение со значением в выпадающем списке! |
+| FACILITY | Учереждение. Обязательно полное совпадение со значением в выпадающем списке! |
+| CAPTCHA_TOKEN | Токен от сервиса [2Captcha](https://2captcha.com/?from=22149884) |
+
+-----
+
+Для работы бот использует браузерный движок Chromium и библиотеку [Playwright for .NET](https://github.com/microsoft/playwright-dotnet)
+
+## Благодарности
+Спасибо [drsslv](https://github.com/drsslv) за его вклад в создание этого бота