Skip to content

Commit 93d578e

Browse files
committed
Documentation updates
1 parent 6001b0a commit 93d578e

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ ngxs-synchronizers requires @ngxs/store as a dependency. Both can be installed f
2929
npm install @ngxs/store ngxs-synchronizers
3030
```
3131

32+
You must import the `NgxsSyncModule` module into the root of your application.
33+
3234
## Quick start
3335

3436
This section assumes you have an existing NGXS-enabled application already set up. Please see the [usage guide](/docs/usage-guide.md) for more detailed usage information.

docs/usage-guide.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ ngxs-synchronizers requires **@ngxs/store** as a dependency. Both can be install
3131
npm install @ngxs/store ngxs-synchronizers
3232
```
3333

34-
Since ngxs-synchronizers is built on top of NGXS, it is important to read through the [NGXS documentation](https://www.ngxs.io/) to understand how NGXS works before proceeding.
34+
You must import the `NgxsSyncModule` module into the root of your application.
35+
36+
Since ngxs-synchronizers is built on top of NGXS, it is recommended to read through the [NGXS documentation](https://www.ngxs.io/) to understand how NGXS works before proceeding.
3537

3638
## Defining a state
3739
_[NGXS docs](https://www.ngxs.io/concepts/state)_

0 commit comments

Comments
 (0)