From da7f2ffd54dde225a02f47c28159f8eab5b397ef Mon Sep 17 00:00:00 2001 From: Yuval Adam Date: Wed, 23 Oct 2013 22:14:24 +0300 Subject: Update README --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 6fb881c..cfdffdd 100644 --- a/README.md +++ b/README.md @@ -1 +1,30 @@ # Traces 5 API + +## Dev + +```bash +$ mkvirtualenv traces +$ pip install -r requirements.txt +$ python app.py +``` + +### Database + +Requires running PostgreSQL instance. + +```bash +$ createdb traces +``` + +Then in a Python shell: + +```python +>>> from app import db +>>> db.create_all() +``` + +## Testing + +```bash +$ curl http://localhost:5000/traces -X POST -d "page=homepage" -d "trace=[[1,5],[6,6],[9,14],[23,77]]" +``` -- cgit v1.3.1