Permalink
Browse files

Added README

git-svn-id: http://shanesbrain.net/svn/rails/plugins/acts_as_most_popular@9 0877a1b9-3f14-db11-838e-000d614e31f0
  • Loading branch information...
1 parent 73229fe commit bd29381683f38ed2b559fc4c91e55188ed91876f shane committed Jul 20, 2006
Showing with 21 additions and 1 deletion.
  1. +21 −1 README
View
@@ -1,4 +1,24 @@
ActsAsMostPopular
=================
-Description goes here
+Makes your models feel like they are in high school again. This plugin retrieves
+model objects with the most popular values for each column. It adds methods of
+the form most_popular_column_name. You can control how many results you get with
+the :limit option. The default limit is 5.
+
+Usage
+=====
+
+class Exercise < ActiveRecord::Base
+ acts_as_most_popular
+end
+
+class YourController < ActionController::Base
+ def index
+ @popular_exercises = Exercise.most_popular_names
+ end
+end
+
+Notes
+=====
+

0 comments on commit bd29381

Please sign in to comment.