README.md in nutcracker-0.2.4.mac9 vs README.md in nutcracker-0.2.4.1

- old
+ new

@@ -1,31 +1,26 @@ # Nutcracker -<a href="https://rubygems.org/gems/nutcracker"><img src=https://fury-badge.herokuapp.com/rb/nutcracker.png></a> +<a href="https://rubygems.org/gems/graphite-api"><img src=https://fury-badge.herokuapp.com/rb/nutcracker.png></a> -This library wraps Twitter's [Nutcracker](https://github.com/twitter/twemproxy) in a gem package and provides a simple ruby API to the `nutcracker` executable. +This "library" wraps Twitter's [Nutcracker](https://github.com/twitter/twemproxy) in a gem package and provides ( in the near future I hope ) simple ruby API to the `nutcracker` executable. +For now this repository only contains a Rakefile for building new `nutcracker` gems, look at the last section for more info. -### Disclaimer -this project is still in its early stages, so things could be a little buggy, if you find one, feel free to [report](https://github.com/kontera-technologies/nutcracker/issues) it. - ## Motivation The main motivation here is to take the advantages of working with Bundler's dependencies management and to be able to embed Twitter's [Nutcracker](https://github.com/twitter/twemproxy) as a dependency to any Ruby project, this allow you to create small-configuration-only-apps tied to specific version of Nutcracker as I show in the example bellow. -## Plugins -- [nutcracker-graphite](https://github.com/kontera-technologies/nutcracker-graphite) - Send cluster stats to Graphite -- [nutcracker-web](https://github.com/kontera-technologies/nutcracker-web) - Web interface +## Installation -### Installation -Add this line to your application's Gemfile: -``` +`gem install nutcracker` + +Or if you are using a `Gemfile` + +```ruby +source :rubygems + gem 'nutcracker' ``` -And then execute: -``` -$ bundle install -``` - after the gem was successfully installed, the `nutcracker` executable should be available ``` [root@somewhere ~]# nutcracker --help This is nutcracker-0.2.3 @@ -47,39 +42,11 @@ -i, --stats-interval=N : set stats aggregation interval in msec (default: 30000 msec) -p, --pid-file=S : set pid file (default: off) -m, --mbuf-size=N : set size of mbuf chunk in bytes (default: 16384 bytes) ``` - -### Ruby Wrapper -a simple ruby wrapper is also included - -```ruby -require 'nutcracker' - -nutcracker = Nutcracker.start(config_file: 'cluster.yaml') -nutcracker.running? # => true - -nutcracker.stats # => {"source"=>"local", "version"=>"0.2.4", "uptime"=>6...} - -nutcracker.stop -nutcracker.running? # => false - -nutcracker.start -nutcracker.join # wait for server to exit -``` - -you can also attach to a running instance of nutcracker - -```ruby -Nutcracker.attach(config_file: 'cluster.yaml', stats_port: 22222) -``` - -### Building new gems +## Wanna build a new version? * Set the version @ `lib/nutcracker/version.rb` ( [Available Versions](https://code.google.com/p/twemproxy/downloads/list) ) * run the `rake build` command * look for `nutcracker-X.Y.Z` gem under the pkg folder -### Warranty -This software is provided “as is” and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose. - -> for more details like licensing etc, please look @ [Nutcracker](https://github.com/twitter/twemproxy) +> for more details like licensing etc, please look @ [Nutcracker](https://github.com/twitter/twemproxy) \ No newline at end of file