context-scoped-state 0.0.3 → 0.0.4

package/README.md

@@ -32,10 +32,11 @@ pnpm add context-scoped-state
 
 ## Quick Start
 
-### 1. Define Your Store
+### 1. Create Your Store (one file, one export)
 
 ```tsx
-import { Store } from 'context-scoped-state';
+// stores/counterStore.ts
+import { Store, createStoreHook } from 'context-scoped-state';
 
 class CounterStore extends Store<{ count: number }> {
   protected getInitialState() {
@@ -50,19 +51,16 @@ class CounterStore extends Store<{ count: number }> {
     this.setState({ count: this.getState().count - 1 });
   }
 }
-```
-
-### 2. Create the Hook
 
-```tsx
-import { createStoreHook } from 'context-scoped-state';
-
-const useCounterStore = createStoreHook(CounterStore);
+// This single export is all you need
+export const useCounterStore = createStoreHook(CounterStore);
 ```
 
-### 3. Use in Components
+### 2. Use in Your App
 
 ```tsx
+import { useCounterStore } from './stores/counterStore';
+
 function Counter() {
   const store = useCounterStore();
 
@@ -75,7 +73,6 @@ function Counter() {
   );
 }
 
-// Wrap with Context provider
 function App() {
   return (
     <useCounterStore.Context>
@@ -85,7 +82,7 @@ function App() {
 }
 ```
 
-That's it. No providers at the root, no selectors, no reducers, no actions, no dispatch.
+That's it. One hook export gives you the hook and its `.Context` provider. No extra setup needed.
 
 ## Examples
 
@@ -190,8 +187,8 @@ No mocking libraries. No global state cleanup. Just render with the state you ne
 
 **vs useState:**
 
-- `useState` binds state logic directly to the component, making it hard to reuse or test independently
-- With `context-scoped-state`, state logic lives in a separate class — reusable across components and easily testable
+- `useState` binds state directly to the component — poor separation of concerns and hard to test since you can't easily set a component to a specific state
+- Lifting state up with `useState` requires refactoring components and passing props; with `context-scoped-state`, just move the Context wrapper up the tree
 
 **vs useReducer:**
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "context-scoped-state",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "license": "MIT",
   "type": "module",
   "repository": {