diff options
| author | Jan T <jans.tuomi@gmail.com> | 2016-07-28 13:21:04 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-07-28 13:21:04 +0300 |
| commit | e73f119d160ce6ffe55953552aa05eb41c44e4af (patch) | |
| tree | b0a9d5cc299b88f0fe7b889a9fb2beb2048de851 /README.md | |
| parent | cacb1a53cacd9f13f44126b55002780b2b5db418 (diff) | |
Update README.md to conform to new design changes
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 17 insertions, 8 deletions
@@ -8,24 +8,33 @@ A Telegram bot to forward messages in a specified Telegram channel to a shoutbox * telepot ### Installation -Radiodiodibot is built on Python 3. You can run the bot in two ways: +1) _radiodiodibot_ is built on Python 3. You can install the dependencies using pip: +``` +$ pip install -r requirements.txt +``` -1) Configure `bot.config` like so: +2) Configure `bot.config` like so: ``` [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: `./radiodiodibot` or `python radiodiodibot` -2) Or just pass the information as command line arguments: -``` -./radiodiodibot -t <YOUR_BOT_TOKEN> -C <TELEGRAM_CHAT_ID> -U <YOUR_API_URL> -i <UPDATE_INTERVAL_IN_SECONDS> +[UPTIME] +Port=<UPTIME_SERVICE_PORT> ``` + +3) Done! + +### Usage +Run _radiodiodibot_ like so: +`./radiodiodibot` or `python radiodiodibot` +Use the _-v_ flag for verbose output. +_radiodiodibot_ logs all its output both to the console and the file _output.log_. + ### Specification -Radiodiodibot communicates with the shoutbox with the following json format: +_radiodiodibot_ communicates with the shoutbox with the following json format: ``` [ { |