Skip to content

Commit

Permalink
usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tj committed Apr 18, 2011
1 parent f4a3d0c commit a8a5ce9
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,21 @@

$ npm install cluster-live

## Usage

Cluster live requires that `stats()` is `use()`ed, enabling connection and "light request" statistics. The `lightRequests` option simply enables light-weight request statistics better suited for realtime reporting.

var live = require('cluster-live');
cluster(server)
.set('workers', 6)
.use(cluster.debug())
.use(cluster.stats({ connections: true, lightRequests: true }))
.use(live())
.listen(3000);

Optionally a `port`, `host` and TLS `options` options may be used to customize and secure the cluster-live server.

## Examples

First start the example application and cluster-live:
Expand Down

0 comments on commit a8a5ce9

Please sign in to comment.