Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dai-shi committed Jul 11, 2024
1 parent 7b85330 commit 41a73f6
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@

A slice utility for Zustand

## Motivation

Zustand is a very minimal global state library.
It's not designed with slice patterns.
But as it's flexible and unopinionated, users invented some slice patterns.
One of which is described in the official Zustand documentation.
However, it's very tricky if you were to use it with TypeScript.

This library provides an opinionated way for a slice pattern.
It's designed to be TypeScript friendly.

## Install

```bash
Expand Down Expand Up @@ -81,7 +92,7 @@ You can also try them directly:
[03](https://stackblitz.com/github/zustandjs/zustand-slices/tree/main/examples/03_actions)
[04](https://stackblitz.com/github/zustandjs/zustand-slices/tree/main/examples/04_immer)

<!--
<!-- This requires React 19 to be released.
[02](https://stackblitz.com/github/zustandjs/zustand-slices/tree/main/examples/02_async)
-->

Expand Down

0 comments on commit 41a73f6

Please sign in to comment.