From eacb313e19805fd8d4bbba1b3515aa9adcd897cf Mon Sep 17 00:00:00 2001
From: Jan T <jans.tuomi@gmail.com>
Date: Mon, 18 Jul 2016 22:29:50 +0300
Subject: Update README.md

---
 README.md | 28 ++++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 039596a..5373db2 100644
--- a/README.md
+++ b/README.md
@@ -8,10 +8,34 @@ A Telegram bot to forward messages in a specified Telegram channel to a shoutbox
 * telepot
 
 ### Installation
-Radiodiodibot is built on Python 3. Running the bot is simple:
+Radiodiodibot is built on Python 3. You can run the bot in two ways:
+
+1) Configure `bot.config` like so:
 ```
-python radiodiodibot.py BOT_TOKEN -C TELEGRAM_CHAT_ID -U SHOUTBOX_API_URL
+[GENERAL]
+TelegramBotToken=<YOUR_BOT_TOKEN>
+ShoutboxApiUrl=<YOUR_API_URL>
+TelegramChatID=<TELEGRAM_CHAT_ID>
+ApiCallInterval=<UPDATE_INTERVAL_IN_SECONDS>
 ```
+And then just run it like so: `python radiodiodibot.py`
 
+2) Or just pass the information as command line arguments:
+```
+python radiodiodibot.py -t <YOUR_BOT_TOKEN> -C <TELEGRAM_CHAT_ID> -U <YOUR_API_URL> -i <UPDATE_INTERVAL_IN_SECONDS>
+```
+### Specification
+Radiodiodibot communicates with the shoutbox with the following json format:
+```
+[
+  {
+    "id": "unique message id",
+    "user": "user name",
+    "text": "message body",
+    "timestamp": "time when message was received",
+    "ip": "IP address of the shoutbox user for moderation purposes"
+  }
+]
+```
 
 Copyright: Jan Tuomi 2016
-- 
cgit v1.3