From 9a14400695d6a972d11efc43f5fd3f4f8194ac43 Mon Sep 17 00:00:00 2001 From: Domizio Demichelis Date: Sun, 21 Mar 2021 16:18:52 +0700 Subject: [PATCH] Small README addition [ci-skip] --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b5845b4c1..0dd29a099 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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: