From f8030f5631e673f15ad57c87c7b7125b73bc090f Mon Sep 17 00:00:00 2001 From: Leonard Chin Date: Sat, 19 Feb 2011 21:30:49 +0900 Subject: [PATCH] Some light editing of the documentation. Small tweaks for readability and typo fixes. --- README.rdoc | 26 +++++++++++++------------- Rakefile | 4 ++-- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.rdoc b/README.rdoc index 643ae12..e352a55 100644 --- a/README.rdoc +++ b/README.rdoc @@ -1,6 +1,6 @@ = Kaminari -A Scope & Engine based clean and powerful and customizable and sophisticated paginator for Rails 3 +A Scope & Engine based, clean, powerful, customizable and sophisticated paginator for Rails 3 == Features @@ -9,27 +9,27 @@ A Scope & Engine based clean and powerful and customizable and sophisticated pag Does not globally pollute Array, Hash, Object or AR::Base. * Easy to use -Just bundle the gem, then your models are ready to be paginated. No configuration. Don't have to define anything in your models or helpers. +Just bundle the gem, then your models are ready to be paginated. No configuration required. Don't have to define anything in your models or helpers. -* Scope based simple API +* Simple scope-based API Everything is method chainable with less "Hasheritis". You know, that's the Rails 3 way. -No special collection class or something for the paginated values but uses a general AR::Relation instance. So, of course you can chain any other conditions before or after the paginator scope. +No special collection class or anything for the paginated values, instead using a general AR::Relation instance. So, of course you can chain any other conditions before or after the paginator scope. -* Engine based I18n aware customizable helper -As the whole pagination helper is basically just a collection of links and non-links, Kaminari renders each of them through its own partial template inside the Engine. So, you can easily modify their behaviour or style or whatever by overriding partial templates. +* Customizable engine-based I18n-aware helper +As the whole pagination helper is basically just a collection of links and non-links, Kaminari renders each of them through its own partial template inside the Engine. So, you can easily modify their behaviour, style or whatever by overriding partial templates. -* ORM, template engine agnostic +* ORM & template engine agnostic Kaminari supports multiple ORMs (ActiveRecord, Mongoid) and multiple template engines (ERB, Haml). * Modern -The pagination helper outputs the HTML5