summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <yuv.adm@gmail.com>2013-03-10 11:56:01 +0200
committerYuval Adam <yuv.adm@gmail.com>2013-03-10 11:56:01 +0200
commit7585a4509aa6df2368ae44ba0a42562f201b1937 (patch)
treeabb5ab8d12052fed6699b7eb3cefe0264b3364a7 /README.md
parent7d578212d4c2684f8e0428ca9792d8b0b8396a5e (diff)
Server, websockets and client boilerplate
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/README.md b/README.md
index d2f6665..8950e62 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,25 @@
# Bitrade
-A simple Bitcoin trading server proof-of-concept.
+A <strike>highly-concurrent, fault-tolerant, malicious-user-proof,</strike> Python-based bitcoin trading server.
+
+Eat this, Mt.Gox - now how you gonna act?
+
+## Usage
+
+Easiest way, run all processes using [foreman](https://github.com/ddollar/foreman):
+
+```bash
+$ foreman start -f Procfile.dev
+```
+
+or the Python-equivalent [honcho](https://github.com/nickstenning/honcho):
+
+```bash
+$ honcho start -f Procfile.dev
+```
+
+Test client available on [http://127.0.0.1:9000](http://127.0.0.1:9000).
+
+## Automated Test Simulation
+
+WIP :)