zukeeper - npm Package Compare versions

Comparing version 0.3.0 to 0.4.0

package.json

 {
   "name": "zukeeper",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Dev Tools for Zustand",
@@ -14,6 +14,6 @@ "main": "index.js",
   "keywords": [
-    "Zustand"
+    "Zustand", "devtools", "time-travel","tree-view","state"
   ],
-  "author": "Chris Olmsted, George Vazquez, Santi Lorenzo, Stephen Lee",
+  "author": "Chris Olmsted, Santi Lorenzo, Stephen Lee, George Vazquez",
   "license": "MIT"
 }

README.md

@@ -1,3 +0,52 @@
-Zukeeper
+# Zukeeper
 
-Simple state management made simpler.
+Zukeeper is a set of devtools for Zustand, in Zustand. v1.0.0 features action and state logging, diffing, state hierarchy visualization, and time travel debugging. It's meant for the Zustand community, so it's fully open source and in active development ([flag issues](https://github.com/oslabs-beta/Zukeeper/issues), send us PRs!)
+
+## How do I use it?
+
+Zukeeper was designed with simplicity in mind, and the setup reflects that. Here's how you can start:
+
+npm install zukeeper
+
+```javascript
+npm i zukeeper
+```
+Import zukeeper into your store creation file
+Pass zukeeper as middleware to create( )
+Assign your store, as you named it, to window.store
+
+![An image showing how to implement Zukeeper when creating a Zustand store](./README%20assets/zukeeperSetup.png)
+
+Zukeeper's publication on the Chrome Web Store is awaiting Google's approval, but in the meantime you can clone this github repo or click here to download the zipped file and load the extension into Chrome in developer mode. For further guidance on that process, [click here](https://bashvlas.com/blog/install-chrome-extension-in-developer-mode/).
+
+That's it! Once your extension is installed and your store is ready, you're good to go. Zukeeper lives in the Chrome devtool panel, just as you'd expect. Open them up, and begin using the tools! We look forward to expanding to additional browsers in upcoming releases.
+
+---
+## What can it do?
+
+Zukeeper's primary features are:
+
+Action and state tracking:
+
+![action and state tracking in Zukeeper](./README%20assets/stateActionTracking.gif)
+
+Diffing:
+
+![diffing in Zukeeper](./README%20assets/diffing.gif)
+
+State hierarchy visualization:
+
+![state hierarchy in Zukeeper](./README%20assets/treeVis.gif)
+
+Time travel debugging:
+
+![time travel debugging in Zukeeper](./README%20assets/timeTravel.gif)
+
+and of course… Dark mode:
+
+
+---
+
+## How can I help?
+
+Use Zukeeper! Hunt bugs, flag issues, and send us PRs! We're excited to bring Zukeeper to the community, and we hope the community will be excited to improve. Here is the repo - we look forward to your contributions!

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6776897

increased by567479.31%

Number of package files

9

increased by125%

Number of lines in readme file

52

increased by1633.33%

No dependency changes