Skip to content

Commit

Permalink
[doc] Added information about the generators
Browse files Browse the repository at this point in the history
  • Loading branch information
3rd-Eden committed Apr 7, 2013
1 parent 23a7f46 commit 261706c
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,20 @@ Some small notes about the options:
- `--workers` as Node.js is single threaded this sets the amount of sub
processes to handle all the heavy lifting.

### Custom messages

Some WebSocket servers have their own custom messaging protocol. In order to
work with those servers we introduced a concept called `generators` a generator
is a small JavaScript file that can output `utf8` and `binary` messages. It uses
a really simple generator by default.

Checkout https://github.com/observing/thor/blob/master/generator.js for an
example of a generator.

```
thor --amount 1000 --generator <file.js> ws://localhost:8080
```

### Example

```
Expand Down

0 comments on commit 261706c

Please sign in to comment.