# Scrivener

[![Build Status](http://travis-ci.org/drewolson/scrivener.svg?branch=master)](http://travis-ci.org/drewolson/scrivener) [![Hex Version](http://img.shields.io/hexpm/v/scrivener.svg?style=flat)](http://hex.pm/packages/scrivener) [![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](http://hexdocs.pm/scrivener)

**Note**: You're probably looking for [Scrivener.Ecto](http://github.com/drewolson/scrivener_ecto). Have a look there first.

Scrivener is a pagination library for the Elixir ecosystem. You most likely won't use Scrivener directly, instead using a library that implements Scrivener's `Paginater` protocol for the type of data you're trying to paginate.

The primary use for Scrivener is the pagination of Ecto queries. For more information, see [Scrivener.Ecto](http://github.com/drewolson/scrivener_ecto).

## Related Libraries

* [Scrivener.Ecto](http://github.com/drewolson/scrivener_ecto) paginate your Ecto queries with Scrivener
* [Scrivener.HTML](http://github.com/mgwidmann/scrivener_html) generates HTML output using Bootstrap or other frameworks
* [Scrivener.Headers](http://github.com/doomspork/scrivener_headers) adds response headers for API pagination
* [Scrivener.List](http://github.com/stephenmoloney/scrivener_list) allows pagination of a list

## Installation

Add `scrivener` to your `mix.exs` `applications` and `dependencies`.

```elixir
def application do
  [applications: [:scrivener]]
end
```

```elixir
[{:scrivener, "~> 2.0"}]
```

## Contributing

You can run the tests with the following command:

```elixir
mix test
```