From f43a931bee121cd0472a495fde0996da35b86f25 Mon Sep 17 00:00:00 2001
From: Olle Jonsson <olle.jonsson@gmail.com>
Date: Mon, 23 Jun 2014 13:35:56 +0200
Subject: [PATCH] Improve details in README

- Mention the Heroku support in the notes
- Mention HipChat API v1
- Mention how to run tests
---
 README.md | 20 +++++++++++---------
 1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 133f3c5..e1fb761 100644
--- a/README.md
+++ b/README.md
@@ -23,21 +23,23 @@ Broadcast presence on HipChat to Olark, receive messages from Olark on HipChat
 	$ source venv/bin/activate
 	$ pip install -r requirements.txt
 
+### Run tests
 
-### Config
-
-Copy src/config-example.py to src/config.py
+In the virtualenv environment, use nose to discover and run tests:
 
-	$ cp src/config-example.py src/config.py
+	$ pip install nose
+	$ nosetests
 
-Create your HipChat API Token (https://hipchat.com/admin/api) with an admin type
-
-Set it in src/config.py (HIPCHAT_TOKEN)
+### Config
 
-Change the room name where to send Olark messages (HIPCHAT_ROOMNAME)
+Configure environment variables listed in src/config.py.
 
-Change the Olark username and password (OLARK_USERNAME, OLARK_PASSWORD)
+* Create a v1 HipChat API Token (https://hipchat.com/admin/api) with an admin type
+* Set it in src/config.py (`HIPCHAT_TOKEN`)
+* Change the room name where to send Olark messages (`HIPCHAT_ROOMNAME`)
+* Change the Olark username and password (`OLARK_USERNAME`, `OLARK_PASSWORD`)
 
+If you deploy on Heroku, installation is automatic, and you only need to scale to a single Worker to start.
 
 ### Execute