Permalink
Browse files

Update README.md

  • Loading branch information...
1 parent fe0c2c7 commit 215ddbacb3a867184fae7b6c3ae15fc4c718d2b3 @nisbus committed Nov 1, 2012
Showing with 32 additions and 1 deletion.
  1. +32 −1 README.md
View
@@ -1,4 +1,35 @@
monterl_carlo_websocket
=======================
-monterl_carlo websocket server
+monterl_carlo websocket server
+
+###Getting started
+
+```bash
+clone git://github.com/nisbus/monterl_carlo_websocket.git
+./rebar get-deps
+./rebar clean compile generate
+./rel/monterl_carlo_websocket/bin/monterl_carlo_websocket console
+```
+
+You now have websocket server running on localhost:8080
+A nice way of testing it is using the [Simple Websocket Client chrome extension](https://chrome.google.com/webstore/detail/simple-websocket-client/pfdhoblngboilpfeibdedpjgfnlcodoo)
+Just type in localhost:8080 and press connect.
+Then copy paste the api samples (one at a time) from below into the request box and hit send.
+
+###API
+
+```json
+{"type":"start", "symbol":"Y"}
+```
+```json
+{"type":"subscribe", "symbol":"Y"}
+```
+```json
+{"type":"stop", "symbol":"Y"}
+```
+```json
+{"type":"graph", "symbol":"Y","graph_type":"statistics","points":5}
+```
+
+Check out [monterl_carlo](https://github.com/nisbus/monterl_carlo) for more parameters to the start and graph methods.

0 comments on commit 215ddba

Please sign in to comment.