Skip to content

Commit

Permalink
Merge pull request #12 from campeterson/master
Browse files Browse the repository at this point in the history
README updates
  • Loading branch information
lucasas committed May 7, 2013
2 parents 59c4c7b + aee43c5 commit beade5a
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
@@ -1,29 +1,29 @@
Will Paginate Mongoid
========

A simple gem that allows you use pagination using Mongoid
A simple gem that allows you to use pagination with Mongoid
---------------------------------------------------------------------

### Why use this gem?

Because will_paginate does not support mongoid `skip` and `limit` methods.
They just supports `paginate` method in `Array` class. So what it means?
Will_Paginate, find all objects and after that cut the needed objects.
It can cause performance problems when you have a lot of objects.
Because will_paginate does not support the mongoid `skip` and `limit` methods.
They just support the `paginate` method in the `Array` class. What does this mean?
Will_Paginate will find all the objects and then cut out the unneeded ones.
This can cause performance problems when you have a lot of objects.

### How I install it?

In your `Gemfile` use `gem "will_paginate_mongoid"` and run `bundle install`
Add `gem "will_paginate_mongoid"` to your `Gemfile` and run `bundle install`

or

Just run `gem install will_paginate_mongoid`

### How it works?

It just create a `paginate` method compatible with will_paginate interface
and add two additional criterias: `skip` and `limit`
It just creates a `paginate` method compatible with will_paginate interface
and adds two additional criteria: `skip` and `limit`

### Just that?
### That's it?

Yes. Now you can use `paginate` method like in [will_paginate documentation](https://github.com/mislav/will_paginate/wiki)
Yes. Now you can use the `paginate` method just like in the [will_paginate documentation](https://github.com/mislav/will_paginate/wiki)

0 comments on commit beade5a

Please sign in to comment.