docs: add README with installation and usage guide

2026-07-29 17:55:43 +05:00
parent 4e58cddcce
commit 43e9f386e1
1 changed files with 95 additions and 0 deletions
@@ -0,0 +1,95 @@
+# ⭐ Auto-Stars
+
+Бот автоматически отправляет Telegram Stars пользователям, которые оставляют посты в указанной теме на Lolz.team.
+
+## Как это работает
+
+Бот следит за выбранной темой на форуме. Когда кто-то публикует новый пост — бот отправляет ему звёзды через Telegram. Опционально может оставлять комментарий под постом.
+
+## Установка
+
+**1. Клонируйте репозиторий**
+```bash
+git clone https://github.com/ваш-ник/auto-stars
+cd auto-stars
+```
+
+**2. Установите зависимости**
+```bash
+pip install -r requirements.txt
+```
+
+**3. Создайте файл `.env`** на основе `.env.example` и заполните его (см. раздел ниже).
+
+**4. Запустите бота**
+```bash
+python main.py
+```
+
+При первом запуске Pyrogram попросит войти в Telegram-аккаунт — введите номер телефона и код подтверждения.
+
+---
+
+## Настройка `.env`
+
+```env
+# Telegram API — получить на https://my.telegram.org
+API_ID=ваш_api_id
+API_HASH=ваш_api_hash
+
+# Lolz.team — токен API из настроек профиля
+LOLZ_TOKEN=ваш_токен
+
+# ID темы на форуме, за которой следит бот
+LOLZ_THREAD_ID=123456
+
+# Сколько звёзд отправлять за каждый пост
+STARS_COUNT=1
+
+# Режим запуска:
+#   1 — мониторинг новых постов в реальном времени
+#   2 — обработать все существующие посты в теме
+DEFAULT_CHOICE=2
+
+# С какой страницы начинать (обычно 1)
+START_PAGE=1
+
+# Как часто проверять новые посты (в секундах, минимум ~0.2)
+CHECK_INTERVAL=30
+
+# Задержка между запросами к API (в секундах, минимум 2)
+API_DELAY=5
+
+# Количество повторных попыток при ошибке
+MAX_RETRIES=3
+
+# Оставлять ли комментарий под постом
+ENABLE_REPLY=true
+
+# Пропускать посты, под которыми уже есть комментарий
+SKIP_COMMENTED=true
+```
+
+---
+
+## Шаблоны ответов
+
+Если `ENABLE_REPLY=true`, бот будет комментировать посты. Тексты берутся из файла `replies.txt`.
+
+Каждая строка — отдельный шаблон. Если в строке несколько вариантов через ` || `, бот выберет один из них случайно:
+
+```
+Спасибо за пост!
+Отличная работа || Молодец || 👍
+✓
+```
+
+Если файл отсутствует или пустой — бот использует `✓` по умолчанию.
+
+---
+
+## Требования
+
+- Python 3.10+
+- Аккаунт Telegram с доступом к [my.telegram.org](https://my.telegram.org)
+- API-токен [Lolz.team](https://lolz.team)