Permalink
Browse files

Added basic README to explain usage

  • Loading branch information...
1 parent f075db2 commit 90ff7257722f503f4b525347b9f18b6106af6239 @nesquena committed Nov 2, 2010
Showing with 23 additions and 0 deletions.
  1. +23 −0 README.md
View
@@ -0,0 +1,23 @@
+INTRODUCTION
+============
+
+This gem is exceptionally simple but also very handy. Let's say you are working in ActiveRecord and you have loaded a collection of objects in a query. You now want to preload associations for these already retrieved objects. This allows you to do that.
+
+USAGE
+=====
+
+The usage of this is very straightforward:
+
+ @users = User.all
+ @users.preload(:posts)
+
+This will eager load all posts for each user even after the initial find query has taken place. You can also use this to preload associations for a member as well:
+
+ @user = User.first
+ @user.preload(:posts)
+
+Why not just do?
+
+ @user.includes(:posts).all
+
+Good question. In most cases this is the better option. This code is for when that approach is not available.

0 comments on commit 90ff725

Please sign in to comment.