summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <yuv.adm@gmail.com>2013-10-23 22:14:24 +0300
committerYuval Adam <yuv.adm@gmail.com>2013-10-23 22:14:24 +0300
commitda7f2ffd54dde225a02f47c28159f8eab5b397ef (patch)
treeb6ad48f48a36e8c032435e349a764ce137d1959a /README.md
parenta93e684b94b26568ceace1f652ede46af0b43b4e (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
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]]"
+```