README.md in nutcracker-web-0.0.3 vs README.md in nutcracker-web-0.0.4
- old
+ new
@@ -5,11 +5,11 @@
<a href="https://rubygems.org/gems/nutcracker-web"><img src=https://fury-badge.herokuapp.com/rb/nutcracker-web.png></a>
<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.
+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.
Also nutcracker-web only supports Redis instances for now.
### Dependencies
- Ruby 1.9+
- [nutcracker-ruby](https://github.com/kontera-technologies/nutcracker)
@@ -52,9 +52,12 @@
nutcracker = Nutcracker.start(config_file: 'cluster.conf')
nutcracker.use(:web, Port: 1234, server: :thin)
nutcracker.join
```
+
+### Gotchas
+- `redis.conf` : don't forget to configure the `maxmemory` attribute for each Redis instance
### Developer
to run nutcracker-web with stub data
- `bundle install`
- run the `rackup` command to start the service.
\ No newline at end of file