zocket 0.0.1

package/README.md

@@ -0,0 +1,29 @@
+# zhub
+
+Synchronize `orbz` instances between Anchors in different environments via Websockets.
+
+This package exports adapters for `bun` and `web` (more later) to simplify synchronizing shared state between multiple sources.
+
+## Bun hub persistence
+
+`createHub()` accepts Orbz Anchor persistence options and passes them through when it creates the hub anchor. For a one-file JSON store:
+
+```js
+import { createHub, createJsonFilePersistence } from "zhub/bun"
+
+const persist = createJsonFilePersistence(new URL("./hub-state.json", import.meta.url))
+const hub = await createHub({ routes, shapes, persist })
+```
+
+The JSON file stores route UUIDs and serialized Orb records in the same format the Anchor adapter reads back during hydration. For databases or split files, pass your own Anchor adapter instead:
+
+```js
+const hub = await createHub({
+  routes,
+  shapes,
+  persist: {
+    adapter,
+    autosave: { intervalMs: 100 },
+  },
+})
+```