Skip to content

Commit

Permalink
[doc][minor] Some small explaination about the options.
Browse files Browse the repository at this point in the history
  • Loading branch information
3rd-Eden committed Apr 7, 2013
1 parent c69ad61 commit 838327c
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,16 @@ Google it.
-b, --binary send binary messages instead of utf-8
-V, --version output the version number
```

Some small notes about the options:

- `--protocol` is the protocol version number. If you want to use the *HyBi drafts
07-12* use `8` as argument or if you want to use the *HyBi drafts 13-17*
drafts which are the default version use `13`.
- `--buffer` should be size of the message in bytes.
- `--workers` as Node.js is single threaded this sets the amount of sub
processes to handle all the heavy lifting.

### License

MIT

0 comments on commit 838327c

Please sign in to comment.