From 510da5061738260c1c29ca57d70c623bc28bc2b0 Mon Sep 17 00:00:00 2001
From: Andrew Williams <andy@tensixtyone.com>
Date: Tue, 12 Aug 2014 11:35:53 +0100
Subject: [PATCH] Added basic README

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7358677
--- /dev/null
+++ b/README.md
@@ -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/)