README.md in nutcracker-web-0.0.5 vs README.md in nutcracker-web-0.0.6

- old
+ new

@@ -1,33 +1,33 @@ -Nutcracker Web +Nutcracker Web <a href="https://rubygems.org/gems/nutcracker-web"><img src=https://fury-badge.herokuapp.com/rb/nutcracker-web.png></a> ============= -[Nutcracker](https://github.com/kontera-technologies/nutcracker) web interface plugin<br/> -<a href="https://rubygems.org/gems/nutcracker-web"><img src=https://fury-badge.herokuapp.com/rb/nutcracker-web.png></a> +Web interface plugin for [nutcracker-ruby](https://github.com/kontera-technologies/nutcracker)<br/> + <img src="https://github.com/kontera-technologies/nutcracker-web/raw/master/pics/pic3.png"/></br> -### 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-web/issues) it. +## Disclaimer +this project is still in its early stages so things could be a little bit buggy, if you find one feel free to report it @ our issue [tracker](https://github.com/kontera-technologies/nutcracker-web/issues).<br/> Also nutcracker-web only supports Redis instances for now. -### Dependencies +## Dependencies - Ruby 1.9+ - [nutcracker-ruby](https://github.com/kontera-technologies/nutcracker) -### Installation -add this to your Gemfile +## Installation +with `bundler` just add this line to your `Gemfile` and then execute `bundle install` ``` gem 'nutcracker-web' ``` - -And then execute: +else you can manually install it by running ``` -$ bundle install +gem install nutcracker-web ``` -### Usage +## Usage +After starting the nutcracker service via [nutcracker-ruby](https://github.com/kontera-technologies/nutcracker) just activate the `nutcracker-web` plugin: ```ruby require 'nutcracker' require 'nutcracker/web' # Start nutcracker @@ -38,13 +38,13 @@ # Sleeping.... nutcracker.join ``` -you can pass default [Rack](https://github.com/rack/rack) [options](https://github.com/rack/rack/blob/master/lib/rack/server.rb#L187..L199) to `Nutcracker#use` ( like :Host, :server etc) +> you can pass default [Rack](https://github.com/rack/rack) [options](https://github.com/rack/rack/blob/master/lib/rack/server.rb#L187..L199) to `Nutcracker#use` ( like :Host, :server etc) -### Custom Webserver +## Custom Webserver to use a different webserver like [thin](http://code.macournoyer.com/thin/) ```ruby require 'nutcracker' require 'nutcracker/web' @@ -53,29 +53,29 @@ nutcracker = Nutcracker.start(config_file: 'cluster.conf') nutcracker.use(:web, Port: 1234, server: :thin) nutcracker.join ``` -### Gotchas +## Gotchas - `redis.conf` : don't forget to configure the `maxmemory` attribute for each Redis instance -### Developer +## Developer ? to run nutcracker-web with stub data - `bundle install` - run the `rackup` command to start the service. - edit `example.json`. - client Backbone app is under `assets` and the Sinatra backend is under the `lib` directory. -### Packaging & Testing +## Packaging & Testing - `rake compile` : compile the assets into a single application.{js,css} file under the public directory - `rake build` : compile the assets & builds a new gem - `rake test` : runs the jasmine tests suite -### 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. - -### More PNGs +## More PNGs <img src="https://github.com/kontera-technologies/nutcracker-web/raw/master/pics/pic1.png"/></br> <hr> <img src="https://github.com/kontera-technologies/nutcracker-web/raw/master/pics/pic2.png"/></br> <hr> -<img src="https://github.com/kontera-technologies/nutcracker-web/raw/master/pics/pic4.png"/></br> \ No newline at end of file +<img src="https://github.com/kontera-technologies/nutcracker-web/raw/master/pics/pic4.png"/></br> + +## 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.