README.md in timestamped_column-0.1.1 vs README.md in timestamped_column-0.2.0
- old
+ new
@@ -1,16 +1,32 @@
-Time-stamped Column
-===================
+# timestamped_column [](http://travis-ci.org/JamesBrooks/timestamped_column>) [](https://gemnasium.com/JamesBrooks/timestamped_column)
-Records modified time for individual columns.
+Records the modification time for specific database columns on individual records (using ActiveRecord).
-Usage (in a model)
-------------------
-`timestamped_column :email_address`
+## Compatibility
-Records the most recent modification time of `:email_address` to `:email_address_updated_at` (defaults to `name_updated_at`)
+Tested and works with:
+* Ruby: 1.8.7, 1.9.2, 1.9.3 and REE.
+* Rails: 3.0, 3.1, 3.2 and edge.
-`timestamped_column :email_address, :column => :email_address_changed_at`
-Records the most recent modification time of `:email_address` to `:email_address_changed_at`
+## Installation
+
+Add `timestamped_column` to your `Gemfile`:
+
+```
+gem 'timestamped_column'
+```
+
+
+## Usage
+
+Usage is similar to how `created_at`/`updated_at` function in Rails. All you need to start tracking attribute modification times is to add a new column to store the modification value. The column that tracks the modification value should be suffxed with either `_updated_at` or `_updated_on`.
+
+
+## Example
+
+If you have a model `User` with an attribute `name` that you want to track the modification time of you just simple add an column named `name_updated_at` (or `name_updated_on`) to the `users` table.
+
+`timestamped_column` checked for the presence of columns named like this and automatically updates these when the attributes they track are changed.