Skip to content

Commit

Permalink
Small README addition [ci-skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
ddnexus committed Mar 21, 2021
1 parent 9b40cdd commit 9a14400
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ _The [IPS/Kb ratio](http://ddnexus.github.io/pagination-comparison/gems.html#eff

### Easy to use

After installing and including Pagy _(see [Quick Start](https://ddnexus.github.io/pagy/how-to#quick-start))_, you can use it in a quite familiar way:
After requiring `pagy` and including its module(s) _(see [Quick Start](https://ddnexus.github.io/pagy/how-to#quick-start))_, you can use it in your controller and views:

Paginate your collection in some controller:

Expand All @@ -92,6 +92,8 @@ Or - if you prefer - render the navigation links with a template:
<%== render partial: 'pagy/nav', locals: {pagy: @pagy} %>
```

However, Pagy goes far beyond the classic pagination above. You can also use fast client-side rendering, headers pagination or integrate it with javascript frameworks (e.g. `vue.js`, `react`, ...) by just requiring the extras that you need.

## Easy to customize

Use the official extras, or write your own in just a few lines. Extras add special options and manage different components, behaviors, Frontend or Backend environments... usually by just requiring them:
Expand Down

0 comments on commit 9a14400

Please sign in to comment.