README.md in middleman-paginate-0.1.4 vs README.md in middleman-paginate-0.1.5
- old
+ new
@@ -1,11 +1,7 @@
# Middleman::Paginate
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/middleman/paginate`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -23,11 +19,11 @@
## Usage
Consider that middleman-paginate creates a page for each set of data sliced from your collection. This page is created by a template. In your config.rb
```ruby
-paginate data.your_collection, "/episodes", "/templates/episodes.html"
+paginate data.your_collection, "/episodes", "/templates/episodes.html", suffix: "/page/:num/index", per_page: 20
```
in your pagination template you'll find a collection named `items` with the objects for the specific page:
```ruby
@@ -45,10 +41,10 @@
```
The final URLs will be:
```
-http://127.0.0.1:4567/episodes.html
+http://127.0.0.1:4567/episodes/index.html
http://127.0.0.1:4567/episodes/page/2.html
http://127.0.0.1:4567/episodes/page/3.html
```
and so on.