Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 2.51 KB

README.md

File metadata and controls

58 lines (41 loc) · 2.51 KB

Useful helpers for state management in React with zustand.

Current GitHub Actions build status npm version Monthly npm downloads PRs welcome!

🎯 Purpose

zustand is a library that keeps state management as simple as you would have always loved it to be. zfy has been built on top of it to provide a useful set of tools to make that experience even more delightful.

🏗️ Installation

yarn add @colorfy-software/zfy

📚 Documentation

The doc is accessible at https://colorfy-software.gitbook.io/zfy.

  • The best way to learn is to follow the guides. They will help you to get up and running in no time.
  • The API reference lists all public APIs.

🤝 Contributing

This library is a very opinionated approach to using zustand that the team uses at colorfy.

Therefore, we might not consider requests that do not align with our goals/vision/use cases for zfy.

However, feel free to voice your opinions if need be: our position might change!

You can also consider doing so from the inside 👀…

See the contributing guide to learn how to contribute to the repository and the development workflow.

📰 License

MIT