README.textile in housekeeper-has_activity-0.4.0 vs README.textile in housekeeper-has_activity-0.4.3
- old
+ new
@@ -1,10 +1,13 @@
h1. HasActivity
---------------
* Originally created by Cary Dunn
* Modified functionality and additional features by HouseKeeper
+ ** Added the ability to sum a column - giving you a total ammount from a date until now or between 2 dates
+ ** Added Between functionality so you can get activity or sums between 2 specified dates
+ ** Created a gem version of this plugin
A simple way to grab recent activity or a sum of values on a given model from a table grouped by day, hour,
or week with only 1 SQL query and giving the ability to pad the results for days/weeks/hours with no activity.
The plugin offers the ability to...
@@ -15,16 +18,54 @@
NOTE: MySQL only because of date functions use.
"Example Google Chart Generated":http://chart.apis.google.com/chart?cht=bvs&chs=200x50&chd=t:0,10,15,3,8,4,0,3,2,3,0,11,4,23,14,0,0,0,13,0,4,8,19,10,12,21,1&chco=336699&chbh=a,2&chds=0,23&chf=bg,s,EFEFEF&
-h2. USAGE / INSTALLATION
+h2. INSTALLATION
------------------------
-<pre><code>script/plugin install git://github.com/cdunn/has_activity.git</pre></code>
+h3. As a standard plugin
+Run the following command in your projects root
<pre><code>
+
+ ruby script/plugin install git://github.com/housekeeper/has_activity.git
+
+</code></pre>
+
+h3. As a RubyGem
+
+
+h4. Step one: Download the gem
+
+Run the following commands
+
+<pre><code>
+
+ gem sources -a http://gems.github.com (you only have to do this once)
+ sudo gem install housekeeper-has_activity
+
+</code></pre>
+
+
+h4. Step two: configure rails
+
+Add the following line inside Rails::Initializer.run do
+
+<pre><code>
+
+ config.gem 'housekeeper-has_activity', :lib => 'has_activity',
+ :source => 'http://gems.github.com'
+
+
+</code></pre>
+
+
+h2. USAGE
+------------------------
+
+<pre><code>
class Feed < ActiveRecord::Base
# Defaults to created_at
has_activity
...
@@ -187,9 +228,7 @@
h2. NOTES
* Using sum and creating Bar Charts is not fully tested - HouseKeeper
* Some work still needs to be done on the queries and a tidy up of has_activity.rb
-Copyright (c) 2009 Cary Dunn <cary.dunn@gmail.com> "http://elctech.com":http://elctech.com, released under the MIT license
-Modified by HouseKeeper
- - Added the ability to sum a column - giving you a total ammount from a date until now or between 2 dates
- - Added Between functionality so you can get activity or sums between 2 specified dates
+Copyright (c) 2009 Cary Dunn <cary.dunn@gmail.com>, HouseKeeper <carl@house-keeping.com>, released under the MIT license
+