docs: flesh out README

2026-08-18 06:26:16 +00:00 · 2026-05-11 20:14:52 +07:00
parent 4b8884f07e
commit ade84a45ba
1 changed files with 16 additions and 1 deletions
@@ -1,3 +1,18 @@
 # forward-telegram-message

-Telegram message-forwarding bot. Forwards messages between specified chats automatically.
+Forward Telegram messages between chats automatically.
+
+## Quick start
+
+```bash
+cp .env.example .env
+# Fill in PHONE, API_ID, API_HASH, SOURCE_GROUP_ID, TARGET_GROUP_ID
+pip install -r requirements.txt
+python main.py
+```
+
+Get `API_ID` and `API_HASH` from [my.telegram.org](https://my.telegram.org).
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).