Add README.md

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..30da377
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+roboconomy
+==========
+
+Setup
+-----
+
+Install dependencies:
+`pip install -r requirements.txt`
+
+Copy `config.yaml.example` to `config.yaml` and fill in the relevant values.
+
+
+Initialising
+------------
+
+Run `python initialise_db.py` to populate the database with users and EXP.
+
+Running
+-------
+
+Run `python bot.py` and leave it running to listen for messages
+
+Commands
+--------
+
+Currently response to the following commands in discord:
+
+- /coins: Shows your current coins
+- /daily: Gives you some coins once a day (or just any time at the moment)
+- /coin_flip [coin bet] [heads or tails]: Flips a coin. Gives you double your bet if you guess correctly
+- /dice: Rolls some dice. Doesn't do anything with the result