README.md in middleman-paginate-0.1.3 vs README.md in middleman-paginate-0.1.4.pre

- old
+ new

@@ -20,10 +20,40 @@ $ gem install middleman-paginate ## Usage -TODO: Write usage instructions here +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" +``` + +in your pagination template you'll find a collection named `items` with the objects for the specific page: + +```ruby +- items.each do |episode| + p= episode.title +``` + +You also have an object `pager` that offers some helpers to build the pagination links: + +```ruby +- if pager.next_page + = link_to "Next page", pager.page_path(pager.next_page) +- if pager.previous_page + = link_to "Previous page", pager.page_path(pager.previous_page) +``` + +The final URLs will be: + +``` +http://127.0.0.1:4567/episodes.html +http://127.0.0.1:4567/episodes/page/2.html +http://127.0.0.1:4567/episodes/page/3.html +``` + +and so on. ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.