improve documentation

README.md

@@ -11,16 +11,18 @@ application up and running.
 
 Things you may want to cover:
 
-* Ruby version
+## Ruby version
 
-* System dependencies
+2.3.1
 
-mongod database working away in background
+## System dependencies
 
-* Configuration
+mongod and redis databases working away in background
+
+## Configuration
 
 *Install mongo*
-brew install mongo
+brew install mongo redis
 
 *make a data directory for mongo databases*
 sudo mkdir -p /data/db
@@ -31,24 +33,45 @@ sudo chown -R $USERNAME /data/
 *run mongo*
 mongod
 
+*run redis*
+redis-server
+
 *to initialise the app run this in root dir of app*
 
 foreman start
 
-* Database creation
+## Database creation
 
 Its a MONGODB so it creates things on the fly as needed, however configuration above must be complete
 
-* Database initialization
+## Database initialization
 
-* How to run the test suite
+## How to run the test suite
 
 ensure phantomjs is installed, brew install phantomjs (or however you prefer)
 
-* Services (job queues, cache servers, search engines, etc.)
+## Services (job queues, cache servers, search engines, etc.)
 
 make sure cucumber dependencies up to date
 
-* Deployment instructions
+## Deployment instructions
+
+## Environment variables
+
+For running tests:
+
+* PUSHER_APP_ID
+* PUSHER_KEY
+* PUSHER_SECRET
+* PUSHER_CLUSTER
+
+For development add:
+
+* AWS_ACCESS_KEY
+* AWS_BUCKET_NAME
+* AWS_SECRET_ACCESS_KEY
+
+In production add:
 
-* ...
+* REDIS_PROVIDER
+* SESSION_SECRET_CSVLINT