Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added Table of Contents to README #97

Closed
wants to merge 1 commit into from
Closed

Added Table of Contents to README #97

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,35 @@

This package allows you to filter, sort and include eloquent relations based on a request. The `QueryBuilder` used in this package extends Laravel's default Eloquent builder. This means all your favorite methods and macros are still available. Query parameter names follow the [JSON API specification](http://jsonapi.org/) as closely as possible.

## Table of Contents

<!-- toc -->

- [Basic usage](#basic-usage)
- [Installation](#installation)
- [Usage](#usage)
* [Including relationships](#including-relationships)
* [Filtering](#filtering)
+ [Exact filters](#exact-filters)
+ [Scope filters](#scope-filters)
+ [Custom filters](#custom-filters)
* [Sorting](#sorting)
* [Selecting specific columns](#selecting-specific-columns)
* [Append attributes](#append-attributes)
* [Other query methods](#other-query-methods)
+ [Pagination](#pagination)
* [Building queries at the front end](#building-queries-at-the-front-end)
* [Testing](#testing)
* [Changelog](#changelog)
- [Contributing](#contributing)
* [Security](#security)
- [Postcardware](#postcardware)
- [Credits](#credits)
- [Support us](#support-us)
- [License](#license)

<!-- tocstop -->

## Basic usage

Filtering an API request: `/users?filter[name]=John`:
Expand Down