active_record_attributes_equality 1.0.0.rc → 1.0.0.rc.2

data/README.md

@@ -1,31 +1,48 @@
-## Introduction
+### Introduction
 
 Active Record Attributes Equality is a very simple rails plugin / gem that forces ActiveRecord to compare the mode's attributes in the presence of two new records.
 
 
-## Example
+### Example
 
 Consider a User model that holds the notion of users that have a name.
 
-# create_table(:user, :force => true) do |t|
-#   t.string :name, null => false
-# end
-class User < ActiveRecord::Base; end
+<pre>
+  # create_table(:user, :force => true) do |t|
+  #   t.string :name, null => false
+  # end
+  class User < ActiveRecord::Base; end
 
-Default ActiveRecord behavior:
+  Default ActiveRecord behavior:
 
-User.new(:name => "John") == User.new(:name => "John") #=> false
+  User.new(:name => "John") == User.new(:name => "John") #=> false
 
-Introduce ActiveRecordAttributesEquality and that same instruction will return true:
+  Introduce ActiveRecordAttributesEquality and that same instruction will return true:
 
-User.new(:name => "John") == User.new(:name => "John") #=> true
+  User.new(:name => "John") == User.new(:name => "John") #=> true
+</pre>
 
 
-## Feedback, questions, improvements, critics or just say hi
+### Installing
+
+#### As a gem (using bundler)
+
+<pre>
+gem "active_record_attributes_equality"
+</pre>
+
+#### As a Rails 3 plugin
+
+<pre>
+rails rails plugin install git@github.com:GnomesLab/active_record_attributes_equality.git
+</pre>
+
+
+### Feedback, questions, improvements, critics or just say hi
 
 Feel free to fork the project and to send pull requests with your changes. Should you run into problems, please use the issue tracker made available in this Github project.
 
 
-## License
+### License
 
 Copyright (c) 2010 Gnomeslab, released under the MIT license. For more information regarding this license type please check the MIT-LICENSE file.

metadata

@@ -7,7 +7,8 @@ version: !ruby/object:Gem::Version
   - 0
   - 0
   - rc
-  version: 1.0.0.rc
+  - 2
+  version: 1.0.0.rc.2
 platform: ruby
 authors: 
 - Diogo Almeida
@@ -34,7 +35,7 @@ dependencies:
         version: 3.0.0.rc
   type: :runtime
   version_requirements: *id001
-description: Active Record Attributes Equality is a very simple rails plugin / gem that forces ActiveRecord to compare the mode's attributes in the presence of two new records.
+description: Active Record Attributes Equality is a very simple rails plugin / gem that forces ActiveRecord to compare the model's attributes in the presence of two new records. Otherwise, it fallsback to ActiveRecord::Base#==.
 email: 
 - diogo.almeida@gnomeslab.com
 executables: []