docs: expand README with setup and configuration details

2026-07-14 09:13:57 +05:00
parent a73ff54140
commit 75262dcddc
1 changed files with 37 additions and 2 deletions
@@ -1,4 +1,39 @@
 # Free Telegram Finder

-Асинхронный Python-скрипт, созданный в рамках бесплатной разработки на форуме Lolz.live для [g](https://telegram.me/ferrruchi); он сканирует страницы с
-  анкетами, извлекает Telegram-ссылки, проверяет свободные юзернеймы и сохраняет найденные результаты в текстовый файл.
+Небольшой асинхронный Python-скрипт для поиска свободных Telegram-юзернеймов.
+
+Скрипт:
+
+- обходит страницы каталога;
+- собирает ссылки на анкеты;
+- достает Telegram из каждой анкеты;
+- проверяет, свободен ли username;
+- сохраняет найденное в `free_telegram.txt`.
+
+## Запуск
+
+```bash
+pip install -r requirements.txt
+python main.py
+```
+
+## Настройки
+
+Основные параметры лежат в `config.py`:
+
+- город и целевой каталог;
+- размер страницы;
+- количество одновременных запросов;
+- паузы и повторы при проверке Telegram.
+
+## Результат
+
+Все найденные совпадения записываются в `free_telegram.txt` в формате:
+
+```text
+https://site/profile - username
+```
+
+## Примечание
+
+Скрипт завязан на текущую верстку сайта и поведение `t.me`, поэтому при изменениях на стороне сайта или Telegram может потребоваться правка парсинга.