README.md in ixtlan-optimistic-0.1.0 vs README.md in ixtlan-optimistic-0.2.0
- old
+ new
@@ -1,9 +1,15 @@
-# Ixtlan Optimistic [](http://travis-ci.org/mkristian/ixtlan-optimistic) #
+# Ixtlan Optimistic #
-it adds optimistic persistence support to DataMapper and ActveRecord usingg the updated_at property/attribute which is automatically updated on any change of the model (for datamapper you need dm-timestamps for that). to load a model use `optimistic_get`/`optimistic_get!`/`optimistic_find` respectively where the first argument is the last `updated_at` value which the client has. if the client data is uptodate then the `optimistic_XYZ` method will return the database entity otherwise raise an exception or return nil respectively.
+* [](http://travis-ci.org/mkristian/ixtlan-optimistic)
+* [](https://gemnasium.com/mkristian/ixtlan-optimistic)
+* [](https://codeclimate.com/github/mkristian/ixtlan-optimistic)
+
+
+it adds optimistic persistence support to DataMapper and ActveRecord using the updated\_at property/attribute which is automatically updated on any change of the model (for datamapper you need dm-timestamps for that). to load a model use `optimistic_get`/`optimistic_get!`/`optimistic_find` respectively where the first argument is the last `updated_at` value which the client has. if the client data is uptodate then the `optimistic_XYZ` method will return the database entity otherwise raise an exception or return nil respectively.
+
## rails setup ##
automagic via included railtie. just add
`gem 'ixtlan-optimistic'
@@ -31,8 +37,18 @@
just add it with
::ActiveRecord::Base.send(:include,
Ixtlan::Optimistic::ActiveRecord)
-# meta-fu #
+Contributing
+------------
-bug-reports, feature request and pull request are most welcome.
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+meta-fu
+-------
+
+enjoy :)