immu-js 0.3.1 → 0.4.0

package/README.md

@@ -2,13 +2,33 @@
 
 A tiny (~2 KB), zero-dependency, framework-independent, store based, reactive state library for JavaScript applications. It's very similar to redux in terms of functionality, but it's much simpler to work with immutable objects. 
 
-It lets you create stores from classes, run effects with automatic dependency tracking with memoisation support. 
+### Why immu-js over redux or zustand or signals? 
 
-It does whatever signals do but little bit better as they are store based and have more options for effects and memos. 
+- **Easier and Simpler**: immu-js is much easier and simpler to work with than redux. No actions to dispatch. Automatic tracking (no need to pass dependencies to effects and memos). 
+- **Store-based**: Unlike signals which are function-based, immu-js is store-based. It lets you group multiple states into one store and import it into wherever you need. 
+- **More options**: immu-js has more options for effects and memos than signals. like you can control when you want to run Effect function by passing dependencies to it which are optional. If no deps passed, then it'll call the effect function when any stores that are used change. if you pass the dependencies, effects are run only if they change.
+- **Framework-independent**: immu-js is framework-independent, which means you can use it with any framework or library but you will need adapters for frameworks if you want to use it with them. 
+- **Zero-dependency**: immu-js has zero-dependency, which means you don't need to install any other packages to use it. 
+- **TypeScript support**: immu-js has full TypeScript support and type inference. 
+- **100% test coverage**: immu-js has 100% test coverage, which means you can trust it to work as expected. 
+- **Small bundle size**: immu-js is very small around 2kb.
 
-use `create` function to create a store from a class, use `run` to run effects (similar to effect in signals), use `memo` to create a computed getter that lets you pass arguments to it and caches the computed result based on stores used in the function and also arguments passed to that function. Use `computed` to create a signals like computed object with value property that has auto computed property. You can also save the store as a version so you can roll back along with `reset` function to reset your stores. That's it. 
 
-**note** you have to assign new values to the properties in the class to detect the change. Library creates a getter and setter for each and every property in the class, so by setting the value through function or from outside, library will know that this value has changed. It treats your store values as immutable. so you will need to reacreate the references for the values at the root level when anything inside the object or array changes. values can be of any type. 
+### How to use? 
+**`create`** function to create a store from a class.
+
+**`run`** to run effects (similar to effect in signals). 
+
+**`memo`** to create a computed getter that lets you pass arguments to it and caches the computed result based on stores used in the function and also arguments passed to that function.
+
+**`computed`** to create a signals like computed object with value property that has auto computed property. You can also save the store as a version so you can roll back to previous versions. 
+
+**`reset`** function to reset your stores. That's it. 
+
+### How does it work? 
+It creates getters and setters for the store properties to track when they are read or written. 
+
+You have to assign new values to the properties in the class to detect the change. Library creates a getter and setter for each and every property in the class after creating an instance to track when they are read or written, so by setting the value through function or from outside, library will know that this value has changed. It treats your store values as immutable. so you will need to reacreate the references for the values at the root level when anything inside the object or array changes. values can be of any type. 
 
 ```typescript
 import { create, memo, computed, run } from "immu-js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "immu-js",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Independent immutable state library for JavaScript/TypeScript",
   "type": "module",
   "main": "./dist/immu-js.cjs",