pocket-state 0.0.4 → 0.0.5

package/README

@@ -0,0 +1,126 @@
+# Pocket State
+
+A lightweight state management library for React, built on top of `useSyncExternalStore`.  
+Designed to be **tiny, fast, and predictable**
+
+---
+
+## Installation
+
+Install with your favorite package manager:
+
+```bash
+# npm
+npm install pocket-state
+
+# yarn
+yarn add pocket-state
+
+```
+
+---
+
+## API
+
+### `createStore<T>(initialState: T, middlewares?: Middleware<T>[])`
+
+Create a new store.
+
+```ts
+import {createStore} from 'pocket-state';
+
+type Counter = {count: number};
+
+const counterStore = createStore<Counter>({count: 0});
+```
+
+---
+
+### `useStore(store, selector?, equalityFn?)`
+
+Subscribe to store state inside a React component.  
+It only re-renders when the selected slice changes.
+
+```tsx
+import {useStore} from 'pocket-state';
+import {counterStore} from './counterStore';
+
+function CounterDisplay() {
+  const count = useStore(counterStore, s => s.count);
+  return <Text>Count: {count}</Text>;
+}
+```
+
+---
+
+### `useShallowStore(store, selector)`
+
+Like `useStore` but uses shallow equality. Useful when selecting an object.
+
+```tsx
+import {useShallowStore} from 'pocket-state';
+
+function Info() {
+  const {count, active} = useShallowStore(counterStore, s => ({
+    count: s.count,
+    active: s.active,
+  }));
+  return (
+    <Text>
+      {count} {active ? 'ON' : 'OFF'}
+    </Text>
+  );
+}
+```
+
+---
+
+### Store API
+
+Each store exposes:
+
+- `getValue()` → current state
+- `setValue(updater)` → update state (`updater` can be partial or producer)
+- `reset(nextState?)` → reset to initial or custom state
+- `subscribe(listener)` → subscribe to all changes
+- `getNumberOfSubscriber()` → count active subscribers
+
+Example:
+
+```ts
+counterStore.setValue(s => ({count: s.count + 1}));
+const state = counterStore.getValue();
+console.log(state.count); // → 1
+```
+
+---
+
+## Example
+
+```tsx
+import React from 'react';
+import {Text, Button, View} from 'react-native';
+import {createStore, useStore} from 'pocket-state';
+
+// Create store
+const counterStore = createStore({count: 0});
+
+export default function App() {
+  const count = useStore(counterStore, s => s.count);
+
+  return (
+    <View>
+      <Text>Count: {count}</Text>
+      <Button
+        title="Increment"
+        onPress={() => counterStore.setValue(s => ({count: s.count + 1}))}
+      />
+      <Button title="Reset" onPress={() => counterStore.reset()} />
+    </View>
+  );
+}
+```
+
+---
+
+🔥 That’s it — no boilerplate, no context providers.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pocket-state",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "tiny global store",
   "main": "src/index",
   "codegenConfig": {
@@ -10,5 +10,5 @@
   },
   "author": " <@kayda69> (nhh.tcp@gmail.com)",
   "license": "ISC",
-  "homepage": "#readme"
+  "homepage": "README"
 }