Skip to content

Commit 93ed9cb

Browse files
committed
fix(docs): Consistently use @ngqp instead of ngqp
1 parent f994b25 commit 93ed9cb

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
[![devDependency Status](https://david-dm.org/Airblader/ngqp/dev-status.svg?branch=master)](https://david-dm.org/Airblader/ngqp#info=devDependencies)
33
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green.svg)](https://conventionalcommits.org)
44

5-
# ngqp – Synchronizing form controls with the URL for Angular
5+
# @ngqp – Synchronizing form controls with the URL for Angular
66

77
<p align="center">
88
<img width="auto" height="240" src="https://raw.githubusercontent.com/Airblader/ngqp/master/logo.svg?sanitize=true">
99
</p>
1010

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

1515
# Installation
@@ -32,7 +32,7 @@ Make sure that your app is set up to use routing (i.e., using `RouterModule`).
3232

3333
# Usage
3434

35-
This section is a work in progress since ngqp is still in an early development stage.
35+
This section is a work in progress since @ngqp is still in an early development stage.
3636

3737
# Contributing
3838

@@ -46,13 +46,13 @@ Angular's router system makes it easy to organize different views under differen
4646
route is not reflected in the URL. This makes it impossible to bookmark or share them as on every new page load the user has
4747
to set these states manually.
4848

49-
With ngqp, you can easily synchronize the state of form controls such as input boxes, dropdowns or your own custom controls
49+
With @ngqp, you can easily synchronize the state of form controls such as input boxes, dropdowns or your own custom controls
5050
with a query parameter on the current URL. This way the URL becomes the single source of truth for this information, which
5151
allows users to share or bookmark these links and reload your page without having to worry about losing their current state.
5252

5353
## What can this be used for?
5454

55-
ngqp will work with any kind of control, but the common scenario would be pagination (i.e., which page a user is on) or
55+
@ngqp will work with any kind of control, but the common scenario would be pagination (i.e., which page a user is on) or
5656
filter settings (search query, selections, …)
5757

5858
---

0 commit comments

Comments
 (0)