honesty 0.3.0 → 0.3.1

data/README.rdoc

@@ -1,56 +1,59 @@
-Honesty
-=================
+= Honesty
 
 Honesty allows developers to store and track user activities and system events in 
 a human-readable, easily-searchable format.
 
-== Resources
+== Installation
 
-Install
+=== Get the gem
 
-* gem install honesty
-* If using bundler:
-** Add "gem 'honesty'" to your Gemfile
-** "bundle install"
+Add Honesty to your Gemfile:
 
- 
-Generate the model:
+  gem 'honesty'
+
+=== Generate the model
+
+Rails 3: 
+
+  rails g honesty
 
-** Rails 3: rails g honesty
-** Rails 2: script/generate honesty
+Rails 2: 
+
+  script/generate honesty
 
 Migrate:
-** rake db:migrate
+
+  rake db:migrate
 
 == Usage
  
- * use Honesty in your ActiveRecord model.
+=== Use Honesty in your ActiveRecord model:
  
- class Shoe < ActiveRecord::Base
- 	honesty
- end
- 
- * Add a fact to a model instance
+  class Shoe < ActiveRecord::Base
+    honesty
+  end
+
+=== Add a fact to a model instance:
  
- Parameters:
- * Context - the object being acted on or the entity being tracked.
- * Agent - the actor, so to speak.
- * Action - the action taking place.
+Parameters:
+* Context - the object being acted on or the entity being tracked.
+* Agent - the actor, so to speak.
+* Action - the action taking place.
 
- shoe = Shoe.create
- shoe.fact("Shoe", "Tim Boisvert", "Created Adidas Superstar II")
+If you want to explicitly denote the context, pass all three parameters
 
- * If you want to short-cut the fact and use the object's class name as the context:
+  shoe = Shoe.create
+  shoe.fact("Shoe", "Tim Boisvert", "Created Adidas Superstar II")
 
- shoe = Shoe.create
- shoe.fact("Tim Boisvert", "Created Adidas Superstar II")
+If you want to short-cut the fact and use the object's class name as the context, just pass in the agent and the action
 
- In this case the context would've been set to the class name of the object calling it -- in this case, Shoe 
+  shoe = Shoe.create
+  shoe.fact("Tim Boisvert", "Created Adidas Superstar II")
 
- * Get facts:
+=== Get facts
  
- shoe = Shoe.find(1)
- facts = shoe.facts.all
+  shoe = Shoe.find(1)
+  facts = shoe.facts.all
 
 == Credits
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Honesty  
-  VERSION = "0.3.0"  
+  VERSION = "0.3.1"  
 end  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honesty
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &14777840 !ruby/object:Gem::Requirement
+  requirement: &19185720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14777840
+  version_requirements: *19185720
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &14777140 !ruby/object:Gem::Requirement
+  requirement: &19185040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14777140
+  version_requirements: *19185040
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &14776420 !ruby/object:Gem::Requirement
+  requirement: &19184620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *14776420
+  version_requirements: *19184620
 description: Store and track user activities and system events in a human-readable,
   easily-searchable format
 email: boisvert@gmail.com