Updated readme. - reportable - Fork of reportable required by WarVox, from hdm/reportable.
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
---
(DIR) commit 9d1f09ef263b73516cb4668d0936eb8fcac694f5
(DIR) parent 5af0207e497c3a9cbf3c60dd5d6f0f0914ecef28
(HTM) Author: Myron Marston <myron.marston@gmail.com>
Date: Sat, 4 Apr 2009 05:48:50 +0800
Updated readme.
Signed-off-by: Marco Otte-Witte <marco.otte-witte@simplabs.com>
Diffstat:
M README.rdoc | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
---
(DIR) diff --git a/README.rdoc b/README.rdoc
@@ -15,6 +15,7 @@ to it with the following options:
* :conditions - Conditions like in ActiveRecord::Base#find; only records that match there conditions are reported on
* :cumulate - Sets whether to cumulate the numbers (instead of [1, 2, 3] returns [1, 3, 6])
* :live_data - Specified whether data for the current reporting period is read; if :live_data is true, you will experience a performance hit since the request cannot be satisfied from the cache only (defaults to false)
+* :end_date - When specified, the report will be for the periods before this date.
<b>Example:</b>
@@ -36,6 +37,7 @@ When invoking the report, you can override some of the options you specified for
* :limit - The number of periods to get (see :grouping)
* :conditions - Conditions like in ActiveRecord::Base#find; only records that match there conditions are reported on
* :live_data - Specified whether data for the current reporting period is read; if :live_data is true, you will experience a performance hit since the request cannot be satisfied from the cache only (defaults to false)
+* :end_date - When specified, the report will be for the periods before this date.
<b>Example:</b>
@@ -64,11 +66,11 @@ Installation requires 3 simple steps:
From your RAILS_ROOT in Rails >= 2.1, do
- ./script/plugin install git://github.com/mk/reports_as_sparkline.git
+ ./script/plugin install git://github.com/myronmarston/reports_as_sparkline.git
If you are on Rails < 2.1, do this from your RAILS_ROOT
- git clone git://github.com/mk/reports_as_sparkline.git vendor/plugins/reports_as_sparkline
+ git clone git://github.com/myronmarston/reports_as_sparkline.git vendor/plugins/reports_as_sparkline
<b>generate migration</b>