kpi 0.3.0 → 0.3.1

data/README.rdoc

@@ -1,8 +1,84 @@
-= kpi
+= Key Performance Indicators
 
-Description goes here.
+This gem helps you to track key indicators in your Rails app.
 
-== Contributing to kpi
+Have you even wanted to get daily reports with information:
+* how many users registered to my app?
+* how many users registered today?
+* what is a total revenue today?
+* how many times certain event occurred in app?
+and so on?
+
+This gem lets you define your application state reports with ease. Look:
+
+== Installation
+
+=== Rails 3.x
+
+Add to your Gemfile:
+
+  gem "kpi"
+  
+and run in console in project directory:
+
+  $ bundle
+
+== Configuration
+
+Create config/initializers/kpi.rb:
+
+  KPI.configure do |c|
+    c.app_name = "Your App Name"
+    c.mail_from = "Your App KPI Service <kpi@example.com>"
+    c.mail_to = "your@email.com"
+  end
+
+== Defining report
+
+Example report in app/models/daily_kpi_report.rb:
+
+  class DailyKpiReport < KPI::Report::Base
+    def users_count
+      return ["Users count", User.count, "Total users count"]
+    end
+    
+    def today_registrations_count
+      return ["Today registrations count", User.where("created_at > ?", @time - 24.hours)]
+    end
+  end
+
+Each defined method should return an array containing 2 or 3 elements:
+* KPI title
+* value
+* optional description
+
+It is important, if your indicator depends on current time (last 24 hours, last week),
+to rely on @time instance variable instead of Time.now. This lets you to generate report
+for every moment in history:
+
+  report = DailyKpiReport.new(2.days.ago)
+
+== Sending report
+
+To collect all statistics and send an email to you just call:
+
+  DailyKpiReport.collect_and_send!
+
+== Other
+* You can override report title by overriding title method in report:
+    class DailyKpiReport < KPI::Report::Base
+      def title; "Your daily report"; end
+      # ...
+    end
+
+== Todo
+
+* Database persistence - storing reports in different databases: PostgreSQL & Mongo prioritized
+* Controllers & views allowing to review stored reports
+* More tests ;)
+
+
+== Contributing to KPI
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it

metadata

@@ -2,7 +2,7 @@
 name: kpi
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Artur Roszczyk
@@ -114,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1994630966239560221
+      hash: -914412323094170311
       segments: 
       - 0
       version: "0"