immu-js 0.2.0 → 0.3.0

package/README.md

@@ -1,8 +1,14 @@
 # immu-js
 
-A tiny (~2 KB), zero-dependency, framework-independent reactive state library for JavaScript and TypeScript.
+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. 
 
-Define your state as a class. `create` turns it into a reactive store. That's it.
+It lets you create stores from classes, run effects with automatic dependency tracking with memoisation support. 
+
+It does whatever signals do but little bit better as they are store based and have more options for effects and memos. 
+
+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. 
 
 ```typescript
 import { create, memo, computed, run } from "immu-js";
@@ -10,8 +16,23 @@ import { create, memo, computed, run } from "immu-js";
 // 1. Define state as a plain class
 class Counter {
   count = 0;
+  address = { 
+    street: "test", 
+  }
+
+  // setter functions
   incr() { this.count++; }
   decr() { this.count--; }
+  setStreet(street: string){
+    // need to reassign the object to trigger the change
+    this.address = { ...this.address, street };
+  }
+
+  // getter functions
+  getStreet(){
+    // you can use functions to get values from the store
+    return this.address.street;
+  }
 }
 
 // 2. Create a reactive store

package/package.json

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