Permalink
Browse files

add some info about installing

  • Loading branch information...
1 parent 216bce9 commit da7bfd0ad031306ae210ac5559ffcbd624ee9710 cronopio committed Sep 14, 2011
Showing with 19 additions and 1 deletion.
  1. +18 −0 README.md
  2. +1 −1 package.json
View
@@ -2,3 +2,21 @@
Hook listening messages on *WebSocket* client connection.
Based on [Peter Griess](https://github.com/pgriess/node-websocket-client) work. [WebSocket Nodejs Client](https://github.com/pgriess/node-websocket-client)
+
+## Requirements
+ - [nodejs](http://nodejs.org)
+ _ [npm](http://npmjs.org)
+
+
+## Installation for test with [MtGox](https://mtgox.com)
+ git clone git://github.com/cronopio/hook.io-ws.git
+ npm install -g ./hook.io-ws
+
+## Installation for My [nodejs](http://nodejs.org) project
+ git clone git://github.com/cronopio/hook.io-ws.git
+ mkdir MyProject
+ cd MyProject
+ npm install ../hook.io-ws
+
+## Usage
+ hookio-websocket
View
@@ -9,7 +9,7 @@
},
"bin": {
"hookio-websocket": "./bin/hookws"
- }
+ },
"main": "lib/hookws",
"engines": {
"node": ">= v0.4.7"

0 comments on commit da7bfd0

Please sign in to comment.