From 2756b0b849d759001a34f89f29164feca9ad4568 Mon Sep 17 00:00:00 2001 From: Jan T Date: Mon, 18 Jul 2016 15:36:52 +0300 Subject: Update README.md --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) 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 -- cgit v1.3