muya 2.0.0 → 2.0.1

package/README.md

@@ -9,10 +9,6 @@ Muya is simple and lightweight react state management library.
 [![Code Quality Check](https://github.com/samuelgja/muya/actions/workflows/code-check.yml/badge.svg)](https://github.com/samuelgja/muya/actions/workflows/code-check.yml)
 [![Build Size](https://img.shields.io/bundlephobia/minzip/muya?label=Bundle%20size)](https://bundlephobia.com/result?p=muya)
 
----
-
-
-## 🚀 **Key Features**
 
 - **Simplified API**: Only `create` and `select`.
 - **Batch Updates**: Built-in batching ensures efficient `muya` state updates internally.
@@ -43,14 +39,14 @@ yarn add muya@latest
 ```typescript
 import { create } from 'muya';
 
-const counter = create(0);
+const useCounter = create(0);
 
 // Access in a React component
 function Counter() {
-  const count = counter(); // Call state directly
+  const count = useCounter(); // Call state directly
   return (
     <div>
-      <button onClick={() => counter.set((prev) => prev + 1)}>Increment</button>
+      <button onClick={() => useCounter.set((prev) => prev + 1)}>Increment</button>
       <p>Count: {count}</p>
     </div>
   );
@@ -80,9 +76,11 @@ const asyncCountSlice = state.select(async (s) => {
 
 ### **Combine Multiple States**
 
-Combine multiple states into a derived state:
+Combine multiple states into a derived state via `select` method:
 
 ```typescript
+import { create, select } from 'muya'
+
 const state1 = create(1);
 const state2 = create(2);
 
@@ -114,7 +112,7 @@ const derived = select([state1, state2], (s1, s2) => s1 + s2, (prev, next) => pr
 Access state directly or through `useValue` hook:
 
 ### **Option 1: Access State Directly**
-
+Each state can be called as the hook directly
 ```typescript
 const userState = create(0);
 
@@ -125,7 +123,7 @@ function App() {
 ```
 
 ### **Option 2: Use the Hook**
-
+Or for convenience, there is `useValue` method
 ```typescript
 import { useValue } from 'muya';
 
@@ -136,7 +134,7 @@ function App() {
 ```
 
 ### **Option 3: Slice with Hook**
-
+For efficient re-renders, `useValue` provides a slicing method.
 ```typescript
 function App() {
   const count = useValue(state, (s) => s.count); // Use selector in hook

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "muya",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "author": "samuel.gjabel@gmail.com",
   "repository": "https://github.com/samuelgjabel/muya",
   "main": "cjs/index.js",

package/src/types.ts

@@ -4,7 +4,7 @@ export type IsEqual<T = unknown> = (a: T, b: T) => boolean
 export type SetStateCb<T> = (value: T | Awaited<T>) => Awaited<T>
 export type SetValue<T> = SetStateCb<T> | Awaited<T>
 export type DefaultValue<T> = T | (() => T)
-export type Listener<T> = (listener: (value?: T) => void) => () => void
+export type Listener<T> = (listener: (value: T) => void) => () => void
 export interface Cache<T> {
   current?: T
   previous?: T

package/types/types.d.ts

@@ -3,7 +3,7 @@ export type IsEqual<T = unknown> = (a: T, b: T) => boolean;
 export type SetStateCb<T> = (value: T | Awaited<T>) => Awaited<T>;
 export type SetValue<T> = SetStateCb<T> | Awaited<T>;
 export type DefaultValue<T> = T | (() => T);
-export type Listener<T> = (listener: (value?: T) => void) => () => void;
+export type Listener<T> = (listener: (value: T) => void) => () => void;
 export interface Cache<T> {
     current?: T;
     previous?: T;