Skip to content

Commit

Permalink
docs: add comment about zustand
Browse files Browse the repository at this point in the history
  • Loading branch information
verekia committed Apr 20, 2024
1 parent 5927033 commit 319c182
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,13 @@ Check out the [**React**](https://manapotion.org/), [**Vue**](https://vue.manapo

<!-- - If you use **React Three Fiber**, install `@manapotion/r3f` -->

- If you use **React**, install `@manapotion/react`
- If you use **React**, install `@manapotion/react` and `zustand` (v4+)
- If you use **Vue**, install `@manapotion/vue`
- If you use **Svelte**, install `@manapotion/svelte`
- If you don't use these frameworks, install `@manapotion/vanilla`

The React version of Mana Potion requires [Zustand](https://github.com/pmndrs/zustand) v4 as a peer dependency. If you do not add Zustand v4 in your dependencies and one of your project dependencies uses Zustand v3 (React Three Fiber for instance), you will get an [error](https://github.com/verekia/manapotion/issues/39).

## Getting started

Add `<Listeners />` somewhere in your app:
Expand Down

0 comments on commit 319c182

Please sign in to comment.