From cf1d1cebeedc9cf8bb4a21a4b6eae70b5e092976 Mon Sep 17 00:00:00 2001 From: Seth Vargo Date: Fri, 1 Jul 2011 08:37:46 -0700 Subject: [PATCH] added user-friendly URLs to documentation --- README.rdoc | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.rdoc b/README.rdoc index b379b2429..51f76b18c 100644 --- a/README.rdoc +++ b/README.rdoc @@ -195,6 +195,20 @@ However, the paginate helper doesn't automatically handle your Array ob Kaminari::paginate_array method converts your Array object into a paginatable Array that accepts page 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