README.md in reportable-1.0.3 vs README.md in reportable-1.1.0
- old
+ new
@@ -44,35 +44,61 @@
[DateTime.now, 1.0],
[DateTime.now - 1.day, 2.0],
[DateTime.now - 2.days, 3.0]
]
-Reportable provides a helper method to generate a sparkline image from this data that you can use in your views:
+Reportable provides helper methods to generate a sparkline image from this data that you can use in your views, e.g.:
- <%= sparkline_tag(User.registrations_report) %>
+ <%= google_report_tag(User.registrations_report) %>
+For other options to generate sparklines see the [API docs](http://rdoc.info/projects/saulabs/reportable).
+
Installation
------------
-To install Reportable, simply run
+To install the Reportable gem, simply run
[sudo] gem install reportable
-and add it to your application's dependencies in your `environment.rb`:
+### Rails 2.x
+To install Reportable for Rails 2.x, add it to your application's dependencies in your `environment.rb`:
+
config.gem 'reportable', :lib => 'saulabs/reportable'
-When you installed the gem, you have to generate the migration that creates Reportable's cache table:
+and generate the migration that create reportable's cache table:
- ./script/generate reportable_migration create_reportable_cache
+ ./script/generate reportable_migration
-and migrate:
+If you want to use reportable's JavaScript graph output format, you also have to generate the JavaScript files:
- rake db:migrate
+ ./script/generate reportable_raphael_assets
+if you want to use [Raphael](http://raphaeljs.com/) or if you want to use [jQuery](http://jquery.com/) and [flot](http://code.google.com/p/flot/):
+ ./script/generate reportable_jquery_flot_assets
+
+### Rails 3.0
+
+To install Reportable for Rails 3.0, add it to your application's Gemfile:
+
+ gem 'reportable', :require => 'saulabs/reportable'
+
+and generate the migration that create reportable's cache table (beware that reportable currently only supports ActiveRecord):
+
+ rails generate reportable_migration
+
+If you want to use reportable's JavaScript graph output format, you also have to generate the JavaScript files:
+
+ rails generate reportable_raphael_assets
+
+if you want to use [Raphael](http://raphaeljs.com/) or if you want to use [jQuery](http://jquery.com/) and [flot](http://code.google.com/p/flot/):
+
+ rails generate reportable_jquery_flot_assets
+
+
Plans
-----
* add support for Oracle and MSSQL
* add support for DataMapper
@@ -81,8 +107,21 @@
Authors
-------
-© 2008-2010 Marco Otte-Witte (<http://simplabs.com>), Martin Kavalar (<http://www.sauspiel.de>)
+© 2008-2010 Marco Otte-Witte (<http://simplabs.com>) and Martin Kavalar (<http://www.sauspiel.de>)
-Released under the MIT license
\ No newline at end of file
+Released under the MIT license
+
+
+Contributors
+------------
+
+* Eric Lindvall (<http://github.com/eric>)
+* Jan Bromberger (<http://github.com/jan>)
+* Jared Dobson (<http://github.com/onesupercoder>)
+* Jarod Reid
+* Lars Kuhnt (<http://github.com/larskuhnt>)
+* Max Schöfmann (<http://github.com/schoefmax>)
+* Myron Marston (<http://github.com/myronmarston>)
+* Ryan Bates (<http://github.com/ryanb>)