aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index ae1643a..039596a 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,17 @@
-# radiodiodibot \ No newline at end of file
+# radiodiodibot
+
+### Description
+A Telegram bot to forward messages in a specified Telegram channel to a shoutbox API and vice versa.
+
+### Dependencies
+* requests
+* telepot
+
+### Installation
+Radiodiodibot is built on Python 3. Running the bot is simple:
+```
+python radiodiodibot.py BOT_TOKEN -C TELEGRAM_CHAT_ID -U SHOUTBOX_API_URL
+```
+
+
+Copyright: Jan Tuomi 2016