Skip to content
Browse files

Merge pull request #134 from sethvargo/master

Added documentation for generating friendly URLs
  • Loading branch information...
2 parents e4e2ef1 + cf1d1ce commit beeb13bbdef784e2e79700c46221b7faab084862 @amatsuda amatsuda committed Jul 1, 2011
Showing with 14 additions and 0 deletions.
  1. +14 −0 README.rdoc
View
14 README.rdoc
@@ -195,6 +195,20 @@ However, the <tt>paginate</tt> helper doesn't automatically handle your Array ob
<tt>Kaminari::paginate_array</tt> method converts your Array object into a paginatable Array that accepts <tt>page</tt> method.
Kaminari.paginate_array(my_array_object).page(params[:page]).per(10)
+== Creating friendly URLs and caching
+
+Because of the `page` parameter and Rails 3 routing, you can easily generate SEO and user-friendly URLs. For any resource you'd like to paginate, just add the following to your `routes.rb`:
+
+ resources :my_resources do
+ get 'page/:page', :action => :index, :on => :collection
+ end
+
+This will create URLs like `/my_resources/page/33` instead of `/my_resources?page=33`. This is now a friendly URL, but it also has other added benefits...
+
+Because the `page` parameter is now a URL segment, we can leverage on Rails page caching[http://guides.rubyonrails.org/caching_with_rails.html#page-caching]!
+
+NOTE: In this example, I've pointed the route to my `:index` action. You may have defined a custom pagination action in your controller - you should point `:action => :your_custom_action` instead.
+
== For more information

0 comments on commit beeb13b

Please sign in to comment.
Something went wrong with that request. Please try again.