@createstore/createstore 0.0.0 → 1.0.0

package/README.md

@@ -24,6 +24,28 @@ function Counter() {
 Every component that reads `'count'` re-renders when any of them changes it. Outside React, use
 `store.getState('count')` and `store.setState('count', 2)`.
 
+### Share state between components
+
+Take `useGlobalState` out of the store, and any component can read or change the same list. No provider, no props
+passed down:
+
+```tsx
+const { useGlobalState } = createStore({ todos: [] as { text: string }[] });
+
+function TodoCount() {
+  const [todos] = useGlobalState('todos');
+  return <p>{todos.length} todos</p>;
+}
+
+function AddTodo() {
+  const [todos, setTodos] = useGlobalState('todos');
+  const add = (text: string) => setTodos([...todos, { text }]);
+  return <Form onAdd={add} />;
+}
+```
+
+`<Form>` stands for your own form component. When `AddTodo` adds a todo, `TodoCount` updates by itself.
+
 Everything else stays off until you use it: computed values, server data with `query()`, persistence, offline
 support, undo/redo, tab sync, events and server rendering.
 
@@ -33,6 +55,14 @@ support, undo/redo, tab sync, events and server rendering.
 - Published with [npm provenance](https://docs.npmjs.com/generating-provenance-statements).
 - Versioned with [semantic versioning](https://semver.org); see [CHANGELOG.md](./CHANGELOG.md) once a release exists.
 
+## Links
+
+- [GitHub repository](https://github.com/Gauravasawa/createstore): source code, issues and releases
+- [npm package](https://www.npmjs.com/package/@createstore/createstore)
+- [Documentation](https://createstore-docs.pages.dev)
+- [Report a bug or request a feature](https://github.com/Gauravasawa/createstore/issues/new/choose)
+- [Security policy](https://github.com/Gauravasawa/createstore/security/policy)
+
 ## License
 
 [MIT](./LICENSE)