diff --git a/README.md b/README.md new file mode 100644 index 0000000..cecf256 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +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_ROOMS``` - List of MUC rooms to join, seperated by commas +* ```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/) diff --git a/requirements.txt b/requirements.txt index 97ddc8a..7161e7f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ -sleekxmpp -eveapi -redis -requests -humanize -dnspython -networkx \ No newline at end of file +sleekxmpp==1.3.1 +eveapi==1.2.6 +redis==2.10.2 +requests==2.3.0 +humanize==0.5 +dnspython==1.11.1 +networkx==1.9