kotovalexarian-likes-github
/
kaminari--kaminari
mirror of https://github.com/kaminari/kaminari.git
1
0
Fork 0
Code Releases Activity

Some light editing of the documentation. 

Small tweaks for readability and typo fixes.
This commit is contained in:
Leonard Chin 2011-02-19 21:30:49 +09:00
parent e3b8db5876
commit f8030f5631
2 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.rdoc
View File

@ -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 <nav> tag by default. Plus, the helper supports the Rails 3 unobtrusive Ajax.
The pagination helper outputs the HTML5 <nav> tag by default. Plus, the helper supports Rails 3 unobtrusive Ajax.
== Supported versions
* Ruby 1.8.7 and 1.9.2 and 1.9.3
* Ruby 1.8.7, 1.9.2, 1.9.3
* Rails 3.0.x and 3.1
* Rails 3.0.x, 3.1
* Haml 3
@ -49,7 +49,7 @@ Then bundle:
=== Query Basics
* the :page scope
To fetch the 7th page of the users (per_page = 25 by default)
To fetch the 7th page of users (per_page = 25 by default)
User.page(7)
* the :per scope
@ -124,7 +124,7 @@ Run the generator first,
then edit the partials in your app's app/views/kaminari/ directory.
* for Haml users
Haml templates generator is also available by adding "-e haml" option (this would actually be automatically invoked while the default template_engine is set to Haml).
Haml templates generator is also available by adding "-e haml" option (this is automatically invoked when the default template_engine is set to Haml).
% rails g kaminari:views default -e haml
@ -141,7 +141,7 @@ To see the full list of avaliable themes, take a look at the themes repository,
Check out Kaminari recipes on the GitHub Wiki for more advanced tips and techniques.
https://github.com/amatsuda/kaminari/wiki/Kaminari-recipes
== Questions, Feedbacks
== Questions, Feedback
Feel free to message me on Github (amatsuda) or Twitter (@a_matsuda) ☇☇☇ :)

4
Rakefile
View File

@ -17,7 +17,7 @@ Jeweler::Tasks.new do |gem|
gem.name = "kaminari"
gem.homepage = "http://github.com/amatsuda/kaminari"
gem.license = "MIT"
gem.summary = 'A pagnation engine plugin for Rails 3'
gem.summary = 'A pagination engine plugin for Rails 3'
gem.description = 'Kaminari is a Scope & Engine based clean and powerful and customizable and sophisticated paginator for Rails 3'
gem.email = "ronnie@dio.jp"
gem.authors = ["Akira Matsuda"]
@ -53,4 +53,4 @@ end
task :test do
Rake::Task[:spec].invoke
end
end