Aktualizace souboru README

README.md

@@ -1,3 +1,35 @@
+Vytvoř README.md pro projekt fedi_welcome_bot.
+
+Obsah:
 # fedi_welcome_bot
 
-Uvítací bot pro nové uživatele Mamutovo.cz
+Uvítací bot pro nové uživatele Mamutovo.cz. Při registraci nového uživatele pošle uvítací toot s odkazem na průvodce.
+
+## Jak to funguje
+- Cron každých 5 minut spustí skript
+- Skript zkontroluje nové účty přes admin API
+- Uvítá pouze účty registrované v posledních 10 minutách
+- Odesílá neveřejný toot (@mention) z bot účtu
+
+## Požadavky
+- Python 3.x (pouze standardní knihovny)
+- Účet s admin:read:accounts oprávněním (pro čtení nových registrací)
+- Bot účet s write:statuses oprávněním (pro posílání tootů)
+
+## Instalace
+1. Klonuj repo
+2. Vytvoř .env soubor:
+BOT_TOKEN=...
+ADMIN_TOKEN=...
+MASTODON_INSTANCE=https://mamutovo.cz
+
+3. Přidej do cronu (crontab -e):
+*/5 * * * * cd /opt/fedi_welcome_bot && python3 welcome_bot.py >> /var/log/fedi_welcome_bot.log 2>&1
+
+## Testování
+python3 welcome_bot.py --dry-run
+
+## Soubory
+- welcome_bot.py – hlavní skript
+- welcomed.json – seznam již uvítaných účtů (generováno automaticky)
+- .env – tokeny (není v repo)