README.md in dashing-rails-1.0.1 vs README.md in dashing-rails-1.0.2

- old
+ new

@@ -1,8 +1,10 @@ # Dashing [![Code Climate](https://codeclimate.com/github/gottfrois/dashing-rails.png)](https://codeclimate.com/github/gottfrois/dashing-rails) +[![Coverage Status](https://coveralls.io/repos/gottfrois/dashing-rails/badge.png?branch=master)](https://coveralls.io/r/gottfrois/dashing-rails?branch=master) +[![Build Status](https://travis-ci.org/gottfrois/dashing-rails.png?branch=master)](https://travis-ci.org/gottfrois/dashing-rails) Dashing-rails is the Rails Engine version of [Dashing by Shopify](http://shopify.github.io/dashing/). A huge thanks to Shopify for their great work with the Sinatra version. ## Introduction @@ -19,10 +21,11 @@ * Drag & Drop interface for re-arranging your widgets. * Host your dashboards on Heroku in less than 30 seconds. ## Requirements +* Ruby >=1.9.3 * Rails 4 * Redis * Multi Threaded server ([puma](https://github.com/puma/puma), [rainbows](http://rainbows.rubyforge.org/)) @@ -99,13 +102,15 @@ Dashing uses [Redis](http://redis.io/) to push and pull data and feed your widgets. Since Dashing [Requirements](https://github.com/gottfrois/dashing-rails#requirements) can be quite frustrating, I thought it might be useful to use redis. This way you can have a seperate Rails 4 application (with puma) running your dashboards and push your data to redis from your main Rails 3 application for example. -You can specify Dashing redis connection in `config/initializers/dashing.rb`: +You can specify Dashing redis credentials in `config/initializers/dashing.rb`: - config.redis = your_redis_instance + config.redis_host = '127.0.0.1' + config.redis_port = '6379' + config.redis_password = '123456' By default Dashing subscribed to the following namespace in redis: dashing_events.* @@ -157,9 +162,15 @@ [Dashing-rails contributors](https://github.com/gottfrois/dashing-rails/contributors) [Shopify Dashing contributors](https://github.com/Shopify/dashing/graphs/contributors) All contributions are more than welcome; especially new widgets! + +Please add spec to your Pull Requests and run them using: + + rake + +You can use the following [demo application](https://github.com/gottfrois/dashing-rails-demo) to test dashing-rails in development. ## License Dashing is released under the [MIT license](https://github.com/Shopify/dashing/blob/master/MIT-LICENSE)