gjendje 0.3.2 → 0.3.4

package/README.md

@@ -2,117 +2,70 @@
 
 # gjendje
 
-**gjendje** unifies state management across any storage backend.
+**gjendje** unifies state management across storage backends.
 
-## Examples
+## Install
 
-#### localStorage
-```ts
-import { state } from 'gjendje'
-
-const theme = state('theme', {
-  default: 'light',
-  scope: 'local',
-})
-
-theme.get()
+```sh
+npm install gjendje
 ```
 
-#### Storage Buckets API
-```ts
-import { state } from 'gjendje'
-
-const settings = state('settings', {
-  default: { notifications: true, theme: 'light' },
-  scope: 'bucket',
-  bucket: {
-    name: 'app-settings',
-  },
-})
-
-await settings.ready
+## Configure
 
-settings.set(prev => ({ ...prev, notifications: false }))
-```
+Sets global defaults for all state instances.
 
-## Configure
+Call once at your app entry point.
 
 ```ts
-configure(config: GjendjeConfig): void
-```
+import { configure } from 'gjendje'
 
-Sets global defaults for all state instances. Call once at app startup before creating any state.
+configure({ scope: 'local' })
+```
 
-#### Settings
+## Usage
 
-- `defaultScope` — `'render'`
-- `keyPattern`
-- `logLevel` — `'warn'`
-- `maxKeys`
-- `prefix`
-- `requireValidation`
-- `ssr`
-- `sync`
-- `warnOnDuplicate`
+```ts
+import { state } from 'gjendje'
 
-#### Lifecycle hooks
+const theme = state('theme', { default: 'light' })
 
-- `onDestroy`
-- `onError`
-- `onHydrate`
-- `onMigrate`
-- `onQuotaExceeded`
-- `onRegister`
-- `onSync`
+theme.scope // 'local' — derived from configure
+```
 
-[Full configure reference](https://github.com/charliebeckstrand/gjendje/blob/main/docs/configure.md) — all options, validation, error handling, and examples.
+[Full configure reference](https://github.com/charliebeckstrand/gjendje/blob/main/docs/configure.md)
 
 ## Scopes
 
 |Scope      |Description                                             |
 |-----------|--------------------------------------------------------|
 |`render`   | `memory` |
-|`local`    |`localStorage`                      |
-|`server`   |`AsyncLocalStorage`                            |
-|`bucket`   | `Storage Buckets` |
+|`local`    |`localStorage` |                   
+|`server`   |`AsyncLocalStorage` |
+|`bucket`   | `Storage Buckets API ` |
 |`url`      |`URLSearchParams` |
 |`tab`      |`sessionStorage` |
 
 ## API
 
-Every `state()` instance exposes the same interface regardless of scope.
-
 #### `get()`
 Returns the current value. Reactive — triggers tracking in `computed` and `effect`.
 
 #### `set(value)` / `set(prev => next)`
 Replaces the current value. Accepts a direct value or an updater function that receives the previous value.
 
+#### `intercept(fn)`
+Receives `(next, prev)` before each update. Return the value to store, or return `prev` to reject the change. Returns an `unsubscribe` function.
+
 #### `subscribe(fn)`
 Calls `fn` on every change. Returns an `unsubscribe` function.
 
 #### `watch(key, fn)`
 Like `subscribe`, but scoped to a single key within an object value. Only fires when that key changes.
 
-#### `intercept(fn)`
-Receives `(next, prev)` before each update. Return the value to store, or return `prev` to reject the change. Returns an `unsubscribe` function.
-
-[Full API reference](https://github.com/charliebeckstrand/gjendje/blob/main/docs/api.md) — all methods, promise lifecycle, options, and types.
-
-## Middleware
-
-Primitives that plug into the update pipeline of any state instance.
-
-#### `intercept(fn)`
-Runs **before** a value is stored. Receives `(next, prev)` and returns the value to actually persist. Return `prev` to reject the update. Multiple interceptors run in registration order.
-
-#### `use(fn)`
-Runs **after** a value is stored. Receives `(next, prev)`. Return value is ignored. Useful for logging, analytics, or syncing external systems.
+[Full API reference](https://github.com/charliebeckstrand/gjendje/blob/main/docs/api.md)
 
 ## Derived state
 
-Primitives that build on top of `state` to handle computed values, collections, and side effects.
-
 #### `computed(deps, fn)`
 Derives a reactive, read-only value from one or more state dependencies. Recomputes only when a dependency changes and caches the result between changes. Returns a `ReadonlyInstance` — no `set()` or `reset()`.
 
@@ -122,10 +75,6 @@ Reactive array with first-class mutation methods — `add`, `remove`, `update`,
 #### `effect(deps, fn)`
 Runs a side effect immediately and re-runs whenever any dependency changes. The callback can return a cleanup function that runs before the next execution and on `stop()`. Returns an `EffectHandle` with a `stop()` method.
 
-## React
-
-[Full React API reference](https://github.com/charliebeckstrand/gjendje/blob/main/docs/react.md)
-
 ## License
 
 MIT