Added basic README

This commit is contained in:
2014-08-12 11:35:53 +01:00
parent 096fdb0bc5
commit 510da50617

20
README.md Normal file
View File

@@ -0,0 +1,20 @@
dropbot
=======
A XMPP bot to provide simple services to NOG8S and Predditors in general
Setup
-----
Dropbot is designed to run on Heroku, but can be ran locally using ```python dropbot\cli.py -c env```
Configuration
-------------
The configuration is passed by using environment variables.
* ```DROPBOT_JID``` - JID of the bot account
* ```DROPBOT_PASSWORD``` - Password of the account
* ```DROPBOT_NICKNAME``` - MUC nickname (defaults to Dropbot)
* ```DROPBOT_CMD_PREFIX``` - Prefix of MUC channel commands (defaults to !)
* ```DROPBOT_KOS_URL``` - URL of the CVA KOS API service (defaults to http://kos.cva-eve.org/api/)