README.rdoc in chain-reactor-0.2.0 vs README.rdoc in chain-reactor-0.2.1

- old
+ new

@@ -1,7 +1,10 @@ = Chain Reactor +{<img src="https://travis-ci.org/joonty/chain-reactor.png?branch=master" alt="Build Status" />}[https://travis-ci.org/joonty/chain-reactor] +{<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/joonty/chain-reactor] + Chain Reactor is a simple server that waits for incoming connections, then kicks off some code when one is made. Clients are locked down by IP address, so you will only recieve connections from known clients. Also, data can be passed via JSON, XML, or anything you like. The "reactions" are written in ruby code, like this: react_to '192.168.0.1' do |data| @@ -29,12 +32,14 @@ $ gem install chain-reactor == Usage -A chain file is required to run, as this specifies which clients to accept and what to do. Fortunately, it's easy to create a template: +Chain reactor comes with two command line tools, <tt>chain-reactor</tt> (the server) and <tt>chain-reactor-client</tt> (I think you can guess). +A chain file is required to run the server, as this specifies which clients to accept and what to do. Fortunately, it's easy to create a template: + $ chain-reactor template > Chainfile.rb Open it up and edit it to your liking. You might want to test it locally first, i.e. only react to 127.0.0.1 addresses. In one terminal, run: $ chain-reactor start Chainfile.rb --ontop @@ -42,9 +47,11 @@ The --ontop option stops it from running as a daemon, making it easier to see what's happening. By default, the chain reactor server runs on port 1987, but that's configurable if you want to change it. In another terminal, run the client with: $ chain-reactor-client --address 127.0.0.1 Follow the instructions by adding key/value pair data to send to the server, then watch it react! + +For more information on configuration, take a look at the wiki. == Contributing 1. Fork it 2. Create your feature branch (<tt>git checkout -b my-new-feature</tt>)