gjendje 0.8.0 → 0.9.2

package/README.md

@@ -2,7 +2,7 @@
 
 # gjendje
 
-Every app juggles localStorage, sessionStorage, URL params, and in-memory state. gjendje replaces that all with a unified API. Choose where state lives. The rest is handled.
+Every app juggles localStorage, URL params, sessionStorage, and in-memory state. **gjendje** replaces storage backends with a unified API. Choose where state lives. The rest is handled.
 
 ## Install
 
@@ -12,24 +12,27 @@ npm install gjendje
 
 ## Quick start
 
-You can pass the scope as an option:
-
 ```ts
 import { state } from 'gjendje'
 
+// Pass scope as an option
 const theme = state({ theme: 'light' }, { scope: 'local' })
+
+// Or use dot notation
+const theme = state.local({ theme: 'light' })
 ```
 
-Or use dot notation as a shorthand:
+For in-memory state that doesn't persist, use `state` without a scope:
 
 ```ts
-const theme = state.local({ theme: 'light' })
+const filters = state({ role: 'all', status: 'active', tags: [] })
 ```
 
-For in-memory state that doesn't persist, use `state` without a scope:
+### Getting values
 
 ```ts
-const store = state({ counter: 0 })
+const filters = store.get() // Returns the full state object
+const { role, status } = store.get() // Get values by destructuring
 ```
 
 ### Updating values
@@ -46,18 +49,17 @@ For object stores, `patch` lets you update specific properties without spreading
 ```ts
 const form = state({ name: '', email: '', age: 0 })
 
-form.patch({ name: 'Alice' }) // only updates name
-form.patch({ name: 'Bob', age: 30 }) // updates multiple properties at once
+form.patch({ name: 'Alice' }) // Only updates name
+form.patch({ name: 'Bob', age: 30 }) // Update multiple properties at once
 ```
 
-[All scopes and examples](https://github.com/charliebeckstrand/gjendje/blob/main/docs/scopes.md)
+[More examples](https://github.com/charliebeckstrand/gjendje/blob/main/docs/examples.md)
 
 ## Configure
 
-Sets global defaults for all state instances.
+Call once at app initialization. Sets global defaults for all state instances.
 
 ```ts
-// app.ts
 import { configure } from 'gjendje'
 
 configure({ scope: 'local' })
@@ -75,16 +77,13 @@ You can also configure global events:
 
 ```ts
 configure({
-  onError: ({ key, scope, error }) => {
-    console.error(`[${key}] (${scope}) error:`, error)
-  },
   onChange: ({ key, scope, value, previousValue }) => {
     console.log(`[${key}] (${scope}) changed:`, previousValue, '→', value)
   },
 })
 ```
 
-[Full configure reference](https://github.com/charliebeckstrand/gjendje/blob/main/docs/configure.md)
+[Configure reference guide](https://github.com/charliebeckstrand/gjendje/blob/main/docs/configure.md)
 
 ## Scopes
 
@@ -97,13 +96,13 @@ configure({
 | `bucket`  | Storage Buckets API  | `state.bucket()`   |
 | `server`  | `AsyncLocalStorage`  | `state.server()`   |
 
-[Scope decision guide](https://github.com/charliebeckstrand/gjendje/blob/main/docs/scopes.md)
+[Scope decision guide](https://github.com/charliebeckstrand/gjendje/blob/main/docs/scopes.md) · [Persistence reference guide](https://github.com/charliebeckstrand/gjendje/blob/main/docs/persistence.md)
 
 ## API
 
-Every scope — `state.local`, `state.session`, `state.url`, `state.bucket`, and `state.server` — shares the same core API: `get`, `set`, `patch`, `reset`, `subscribe`, `watch`, `intercept`, and more.
+Every scope shares the same core API: `get`, `set`, `patch`, `reset`, `subscribe`, `watch`, `intercept`, `use`, `destroy`
 
-[Full API reference](https://github.com/charliebeckstrand/gjendje/blob/main/docs/api.md) · [Persistence reference](https://github.com/charliebeckstrand/gjendje/blob/main/docs/persistence.md)
+[API reference guide](https://github.com/charliebeckstrand/gjendje/blob/main/docs/api.md)
 
 ## Derived state
 
@@ -122,13 +121,7 @@ Runs a side effect immediately and re-runs whenever any dependency changes. The
 #### `readonly(instance)`
 Creates a read-only view of any state or computed instance. Exposes `get`, `peek`, `subscribe`, and lifecycle — but no `set`, `reset`, `intercept`, or `use`. Zero runtime cost.
 
-[Full derived state reference](https://github.com/charliebeckstrand/gjendje/blob/main/docs/derived.md)
-
-## Examples
-
-Real-world patterns and recipes — persistence with migration, cross-tab sync, derived state, collections, and more.
-
-[Examples](https://github.com/charliebeckstrand/gjendje/blob/main/docs/examples.md)
+[Derived state reference guide](https://github.com/charliebeckstrand/gjendje/blob/main/docs/derived.md)
 
 ## License
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gjendje",
-  "version": "0.8.0",
-  "description": "TypeScript state management",
+  "version": "0.9.2",
+  "description": "Unified storage backend state management, built with TypeScript",
   "keywords": [
     "state",
     "storage",