From b4e31f28a0a85b8ffd5f390d07629755fa229be8 Mon Sep 17 00:00:00 2001 From: Jose Padilla Date: Sat, 12 Jul 2014 23:34:27 -0600 Subject: [PATCH] update readme file --- README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e71d4da..443b5e5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,22 @@ -chatrooms +Chatrooms ========= -Simple chat app made with django +Chatrooms API made with Django. + +##Installation +============== + +NOTE: This project assumes that you have python 2.7 installed on your machine. + +First you will need redis to run this project. If you do not have redis installed you can get at http://redis.io/download for your OS. Then you will need to start the redis server. Details on the redis site. + +Then create a new virtual environment, activate it and `pip install -r requirements.txt` + +Next run `python manage.py syncdb` and `python manage.py runserver`. + +Go to http://localhost:8000/ in your browser and you will see the demo running. + +##TODO +====== + +Finish API and Documentation