Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Arabinda committed Jan 5, 2025
1 parent 314dd34 commit 6d95329
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ API.
- Modular state management:
- Derived selectors
- Derived actions
- `immer`, `devtools` and `persist` middlewares
- `immer`, `devtools` , `mutative` and `persist` middlewares
- Full typescript support
- `react-tracked` support

Expand Down Expand Up @@ -284,10 +284,11 @@ The second parameter of `createStore` is for options:

```ts
export interface CreateStoreOptions {
name: string;
devtools?: DevtoolsOptions;
immer?: ImmerOptions;
mutative?: MutativeOptions;
persist?: PersistOptions;
name: string;
}
```

Expand All @@ -297,6 +298,7 @@ ZustandX is using these middlewares:

- `immer`: enabled if `immer.enabled` option is `true`. `immer` implements from [zustand](https://github.com/pmndrs/zustand?tab=readme-ov-file#immer-middleware).
- `devtools`: enabled if `devtools.enabled` option is `true`. `devtools` implements `DevtoolsOptions` interface from [zustand](https://github.com/pmndrs/zustand?tab=readme-ov-file#redux-devtools).
- `mutative`: enabled if `mutative.enabled` option is `true`.
- `persist`: enabled if `persist.enabled` option is `true`. `persist`
implements `PersistOptions` interface from
[zustand](https://github.com/pmndrs/zustand#persist-middleware)
Expand Down

0 comments on commit 6d95329

Please sign in to comment.