From 7f5db3f2ceaba1558daeabd7612347e4cb341345 Mon Sep 17 00:00:00 2001 From: Andy Rossmeissl Date: Tue, 27 Apr 2010 14:44:29 -0400 Subject: [PATCH] Readme --- README.rdoc | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.rdoc b/README.rdoc index 5c3fe23..cc6b295 100644 --- a/README.rdoc +++ b/README.rdoc @@ -1,16 +1,15 @@ = grafico -Description goes here. +Rails (2.x - 3.x) view helpers for graphs using {Grafico}[http://grafico.kilianvalkhof.com/], a javascript graphic library built on {Raphael}[http://raphaeljs.com/]. -== Note on Patches/Pull Requests - -* Fork the project. -* Make your feature addition or bug fix. -* Add tests for it. This is important so I don't break it in a - future version unintentionally. -* Commit, do not mess with rakefile, version, or history. - (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) -* Send me a pull request. Bonus points for topic branches. +== Installation + +* Add the gem to your Rails app, either through an initializer (Rails 2.x with rake gems:install) or its Gemfile (Rails 3 with bundle install). +* Use the grafico_assets generator to add the necessary javascript libraries to your app. + +== Acknowledgements + +Inspired by {reportable}[http://github.com/saulabs/reportable]. == Copyright