@ngqp/core/README.md

Synchronizing form controls with the URL for Angular

[![Build Status](https://travis-ci.org/TNG/ngqp.svg?branch=master)](https://travis-ci.org/TNG/ngqp)
[![npm version](https://badge.fury.io/js/%40ngqp%2Fcore.svg)](https://www.npmjs.com/@ngqp/core)
[![Coverage](https://codecov.io/gh/TNG/ngqp/branch/master/graph/badge.svg)](https://codecov.io/gh/TNG/ngqp/)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg)](https://conventionalcommits.org)
[![Gitter](https://img.shields.io/gitter/room/TNG/ngqp.svg?style=flat-square)](https://gitter.im/ngqp)

<p align="center">
    <a href="https://ngqp.io">
        <img width="auto" height="72" src="https://raw.githubusercontent.com/TNG/ngqp/master/logo.svg?sanitize=true" alt="ngqp logo">
    </a>
</p>

<h3 align="center">ngqp</h3>

<p align="center">
    Declaratively synchronize form controls with the URL
    <br>
    <a href="https://ngqp.io/#/docs"><strong>Documentation</strong></a>
</p>

## Description

ngqp makes it easy to synchronize form controls with query parameters in your URL by using a declarative approach. Examples
include pagination information or the current settings of filters in a data view. ngqp is designed to resemble the Forms API
from `@angular/forms`, making it intuitive to work with.

## Quick Start

```
ng add @ngqp/core
```

Read the [Getting Started](https://www.ngqp.io/#/getting-started) page for information on how to use it.

## Contributing

See [CONTRIBUTING.md][contributing].

## Code of Conduct

Please take a moment to read the [Code of Conduct][coc].

---

[MIT License][license]

[license]: https://www.github.com/TNG/ngqp/blob/master/LICENSE
[contributing]: https://www.github.com/TNG/ngqp/blob/master/CONTRIBUTING.md
[coc]: https://www.github.com/TNG/ngqp/blob/master/CODE_OF_CONDUCT.md