README.md in sneakers-1.0.4 vs README.md in sneakers-1.1.0

- old
+ new

@@ -25,21 +25,26 @@ ## Installation Add this line to your application's Gemfile: - gem 'sneakers' +``` ruby +gem 'sneakers' +``` And then execute: - $ bundle +``` shell-session +$ bundle +``` Or install it yourself as: - $ gem install sneakers +``` shell-session +$ gem install sneakers +``` - ## Quick start Set up a Gemfile ```ruby @@ -72,14 +77,12 @@ ack! end end ``` +We'll count errors and error types with Redis. As an example, make a message that looks like this: -As an example, make a message look like this: -We'll count errors and error types with Redis. Specifically for an error that looks like this: - ```javascript { "type": "error", "message": "HALP!", "error": "CODE001" @@ -88,12 +91,12 @@ Let's test it out quickly from the command line: -```bash -sneakers work Processor --require boot.rb +```shell-session +$ sneakers work Processor --require boot.rb ``` We just told Sneakers to spawn a worker named `Processor`, but first `--require` a file that we dedicate to setting up environment, including workers and what-not. If you go to your RabbitMQ admin now, you'll see a new queue named `logs` was created. Push a couple messages, and this is the output you should see at your terminal. @@ -107,12 +110,12 @@ ``` And redis will show this: -``` -➜ ~ redis-cli monitor +``` shell-session +$ redis-cli monitor 1381520329.888581 [0 127.0.0.1:49182] "incr" "processor:CODE001" ``` We're basically done with the ceremonies and all is left is to do some real work. @@ -140,17 +143,21 @@ 2013-10-11T19:44:37Z p-9219 t-oxh8owywg INFO: INC: work.Processor.started 2013-10-11T19:44:37Z p-9219 t-oxh8owywg INFO: TIME: work.Processor.time 0.00242 2013-10-11T19:44:37Z p-9219 t-oxh8owywg INFO: INC: work.Processor.handled.ack ``` -Which increments start + end, and times the work unit. +Which increments `started` and `handled.ack`, and times the work unit. - From here, you can continue over to the [Wiki](https://github.com/jondot/sneakers/wiki) +# Compatibility + +* Sneakers 1.1.x and up (using the new generation Bunny 2.x) - Ruby 2.x.x +* Sneakers 1.x.x and down - Ruby 1.9.x, 2.x.x + # Contributing Fork, implement, add tests, pull request, get my everlasting thanks and a respectable place here :). @@ -160,13 +167,6 @@ # Copyright -Copyright (c) 2015 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot). See MIT-LICENSE for further details. - - - - - - - +Copyright (c) 2015 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot). See [LICENSE](LICENSE.txt) for further details.