stunk 1.2.2 → 1.2.4

package/README.md

@@ -139,6 +139,8 @@ age.set(-5); // ❌ Throws an error: "Value must be non-negative!"
 
 ## Time Travel (Middleware)
 
+The withHistory middleware extends a chunk to support undo and redo functionality. This allows you to navigate back and forth between previous states, making it useful for implementing features like undo/redo, form history, and state time travel.
+
 ```typescript
 import { chunk } from "stunk";
 import { withHistory } from "stunk/midddleware";
@@ -205,7 +207,7 @@ console.log(fullInfoChunk.get());
 
 Computed chunks are ideal for scenarios where state depends on multiple sources or needs complex calculations. They ensure your application remains performant and maintainable.
 
-### Advanced Examples
+## Advanced Examples
 
 Form Validation Example
 
@@ -291,6 +293,27 @@ const counterChunk = withPersistence(chunk({ count: 0 }), {
 counterChunk.set({ count: 1 });
 ```
 
+Using Different Storage
+
+```typescript
+// Use sessionStorage instead of localStorage
+const sessionStorageChunk = withPersistence(baseChunk, {
+  key: "counter",
+  storage: sessionStorage,
+});
+```
+
+Custom Serialization
+
+```typescript
+// Add custom serialization/deserialization
+const encryptedChunk = withPersistence(baseChunk, {
+  key: "encrypted-data",
+  serialize: (value) => encrypt(JSON.stringify(value)),
+  deserialize: (value) => JSON.parse(decrypt(value)),
+});
+```
+
 ## Async State
 
 Async Chunks in Stunk are designed to manage asynchronous state seamlessly. They handle loading, error, and data states automatically, making it easier to work with APIs and other asynchronous operations.

package/package.json

@@ -1,7 +1,15 @@
 {
   "name": "stunk",
-  "version": "1.2.2",
-  "description": "Stunk - A lightweight, framework-agnostic state management library using chunk-based units for efficient state updates.",
+  "version": "1.2.4",
+  "description": "Stunk is a lightweight, framework-agnostic state management library for JavaScript and TypeScript. It uses chunk-based state units for efficient updates, reactivity, and performance optimization in React, Vue, Svelte, and Vanilla JS/TS applications.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/I-am-abdulazeez/stunk"
+  },
+  "homepage": "https://github.com/I-am-abdulazeez/stunk#readme",
+  "bugs": {
+    "url": "https://github.com/I-am-abdulazeez/stunk/issues"
+  },
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",
   "scripts": {
@@ -13,19 +21,33 @@
   "keywords": [
     "state-management",
     "atomic-state",
+    "chunk-based state",
     "framework-agnostic",
-    "stunk",
-    "state",
-    "chunk",
-    "react",
+    "reactive state library",
+    "frontend state management",
+    "JavaScript state management",
+    "TypeScript state management",
     "React state management",
     "Vue state management",
-    "management",
-    "TypeScript state management",
-    "reactive state library",
-    "frontend state management"
+    "Svelte state management",
+    "recoil alternative",
+    "jotai alternative",
+    "zustand alternative",
+    "lightweight state management",
+    "state container",
+    "reusable state",
+    "efficient state updates",
+    "performance optimization",
+    "stunk",
+    "chunk"
   ],
   "author": "AbdulAzeez",
+  "contributors": [
+    {
+      "name": "AbdulAzeez",
+      "url": "https://github.com/I-am-abdulazeez"
+    }
+  ],
   "license": "MIT",
   "devDependencies": {
     "@types/jest": "^29.5.14",