Skip to content

Commit

Permalink
Update README for newbies
Browse files Browse the repository at this point in the history
* Prepare ringpop for development.
* Update the max open file limit (needed in default settings of OSX).
* Introduce tick-cluster to the README.
  • Loading branch information
motiejus committed Feb 3, 2016
1 parent 18d3e93 commit 8a20308
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 2 deletions.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,34 @@ and provides request forwarding as a routing convenience. It can be used to
shard your application in a way that's scalable and fault tolerant.

# Installation
To install Ringpop:
To install Ringpop for usage as a library:

```
npm install ringpop
```

Prepare the current directory for development:

```
npm install
```

To be able to run the tests, make sure you have your open file limit
restriction on at least 4K:

```
ulimit -n 4096
```

# Tick Cluster
An example application `scripts/tick-cluster.js` is included to this
repository. It just launches a ringpop cluster of a given size. Using this
application is the quickest way to start a ringpop cluster.

```
./scripts/tick-cluster.js --interpreter node main.js
```

# Example
Run a 2-node Ringpop cluster from the command-line. Install Ringpop
and TChannel, copy/paste the below into your editor and run!
Expand Down
2 changes: 1 addition & 1 deletion scripts/tick-cluster.js
Original file line number Diff line number Diff line change
Expand Up @@ -561,7 +561,7 @@ function send(host, arg1, arg2, arg3, callback) {
program
.version(require('../package.json').version)
.option('-n <size>', 'Size of cluster. Default is ' + procsToStart + '.')
.option('-i, --interpreter <interpreter>', 'Interpreter that runs program.')
.option('-i, --interpreter <interpreter>', 'Interpreter that runs program. Usually `node`.')
.option('--interface <address>', 'Interface to bind ringpop instances to.')
.option('--port <num>', 'Starting port for instances.')
.arguments('<program>')
Expand Down

0 comments on commit 8a20308

Please sign in to comment.