Skip to content

Commit

Permalink
docs: how to install
Browse files Browse the repository at this point in the history
  • Loading branch information
satanTime committed Jan 16, 2021
1 parent 155bd68 commit e02b8da
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@

**Important links**

- Here you can read [documentation with examples](https://ngrx-entity-relationship.sudo.eu)
- [Documentation with examples](https://ngrx-entity-relationship.sudo.eu)
- [GitHub repo](https://github.com/satanTime/ngrx-entity-relationship)
- [NPM package](https://www.npmjs.com/package/ngrx-entity-relationship)

* Live [Redux example on CodeSandbox](https://codesandbox.io/s/github/satanTime/ngrx-entity-relationship-react?file=/src/MyComponent.tsx)
* Live [NGRX example on CodeSandbox](https://codesandbox.io/s/github/satanTime/ngrx-entity-relationship-angular?file=/src/app/app.component.ts)
Expand Down Expand Up @@ -68,8 +70,8 @@ Profit.

## What you could do next

- [watch updates on github](https://github.com/satanTime/ngrx-entity-relationship),
- [give a star](https://github.com/satanTime/ngrx-entity-relationship),
- [share on twitter](https://twitter.com/intent/tweet?text=Check+ngrx-entity-relationship+package&url=https%3A%2F%2Fgithub.com%2FsatanTime%2Fngrx-entity-relationship).
- [watch updates on github](https://github.com/satanTime/ngrx-entity-relationship)
- [give a star](https://github.com/satanTime/ngrx-entity-relationship)
- [share on twitter](https://twitter.com/intent/tweet?text=Check+ngrx-entity-relationship+package&url=https%3A%2F%2Fgithub.com%2FsatanTime%2Fngrx-entity-relationship)

Thank you!
10 changes: 10 additions & 0 deletions docs/guide/quick.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,16 @@ we need to follow the next rules:
> If you need a solution for `@ngrx/data`,
> then please read [the related section](ngrx-data.md) after this manual.
## Installation

```shell
npm install ngrx-entity-relationship --save
```

```shell
yarn add ngrx-entity-relationship
```

## Normalized state structure for Redux and NGRX

The first step is to ensure that entities are reduced into **the proper state**, there are two properties usually:
Expand Down

0 comments on commit e02b8da

Please sign in to comment.