README.markdown in better_ar-0.0.3 vs README.markdown in better_ar-0.0.4
- old
+ new
@@ -1,18 +1,39 @@
# BetterAr
-BetterAr adds replaces the .all, .first and .count methods for ActiveRecord.
+BetterAr replaces the .all, .first and .count methods for ActiveRecord.
+
+## Install
+
+Bundler:
+
+ gem 'better_ar'
+
+Command line:
+
+ gem install better_ar
+
+## Usage
+
Now a single hash can be passed to ActiveRecord::Base.all that contains not only the where values but also other scopes like 'limit' and 'order'
- User.all(:age => 10, :limit => 5, :offset => 10, :order => :name)
+ User.all(:age => 10, :limit! => 5, :offset! => 10, :order! => :name)
is the same as
User.where(:age => 10).limit(5).offset(10).order(:name)
While this may seem less concise the advantage is being able to dynamically construct the query with a single hash in code.
-This library completely removes the old .all, .first and .count class methods on ActiveRecord::Base. As these methods were just delegated to the ActiveRecord::Base.scoped they can still be called.
+This library completely removes the old .all, .first and .count class methods from ActiveRecord::Base. As these methods were just delegated to ActiveRecord::Base.scoped they can still be called.
-Brian Cardarella - 2011
+### Legacy
+
+If the params contain :condition it will fall back to the legacy method.
+
+## Other
+
+Brian Cardarella (c) 2011
+
+License: MIT (see MIT-LICENSE.txt)