README.md in nutcracker-0.2.4.8 vs README.md in nutcracker-0.2.4.9
- old
+ new
@@ -2,11 +2,11 @@
<a href="https://rubygems.org/gems/nutcracker"><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.
### 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.
+this project is still in its early stages so things could be a little bit 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
@@ -64,9 +64,15 @@
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
* Set the version @ `lib/nutcracker/version.rb` ( [Available Versions](https://code.google.com/p/twemproxy/downloads/list) )
* run the `rake build` command