From 7585a4509aa6df2368ae44ba0a42562f201b1937 Mon Sep 17 00:00:00 2001
From: Yuval Adam <yuv.adm@gmail.com>
Date: Sun, 10 Mar 2013 11:56:01 +0200
Subject: Server, websockets and client boilerplate

---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

(limited to 'README.md')

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 :)
-- 
cgit v1.3.1