@rljson/server 0.0.4 → 0.0.6

package/dist/README.blog.md

@@ -8,4 +8,12 @@ found in the LICENSE file in the root of this package.
 
 # Blog
 
-Add latest posts at the end.
+Add posts as Markdown entries in this file (newest last). Keep each post small and link to source code or PRs when helpful. Template:
+
+```md
+## YYYY-MM-DD — Title
+
+- What changed (1–3 bullets)
+- Why it matters
+- Links: PRs, docs, demos
+```

package/dist/README.contributors.md

@@ -8,25 +8,59 @@ found in the LICENSE file in the root of this package.
 
 # Contributors Guide
 
-- [Prepare](#prepare)
-- [Develop](#develop)
-- [Administrate](#administrate)
-- [Fast Coding](#fast-coding)
+- [Prerequisites](#prerequisites)
+- [Setup](#setup)
+- [Everyday development](#everyday-development)
+- [Publishing](#publishing)
+- [More docs](#more-docs)
 
-## Prepare
+## Prerequisites
 
-Read [prepare.md](doc/prepare.md)
+- Node.js v22.14.0+
+- pnpm v10 (see [install-node-mac.md](doc/install-node-mac.md) or [install-node-win.md](doc/install-node-win.md))
+- Optional: sibling repos `rljson-io`, `rljson-bs`, `rljson-db`, `rljson` if you prefer linking for local development
 
-<!-- ........................................................................-->
+## Setup
 
-## Develop
+```sh
+pnpm install
+```
 
-Read [develop.md](doc/develop.md)
+By default we consume published npm versions. If you want to work against local packages instead, `pnpm link` them in sibling folders and add temporary overrides as needed.
 
-## Administrate
+## Everyday development
 
-Read [create-new-repo.md](doc/create-new-repo.md)
+- Run tests + lint (default CI path):
 
-## Fast Coding
+  ```sh
+  pnpm test
+  ```
 
-Read [fast-coding-guide.md](doc/fast-coding-guide.md)
+- Lint only:
+
+  ```sh
+  pnpm lint
+  ```
+
+- Build the package (emits dist, copies README):
+
+  ```sh
+  pnpm build
+  ```
+
+- Update goldens for snapshot-like tests:
+
+  ```sh
+  pnpm updateGoldens
+  ```
+
+## Publishing
+
+`pnpm build` runs `pnpm test` via `prebuild`. `pnpm publish` (or npm publish) will trigger `prepublishOnly` and uses the built `dist` folder. Keep the changelog and versioning in sync with repo guidelines.
+
+## More docs
+
+- [doc/prepare.md](doc/prepare.md)
+- [doc/develop.md](doc/develop.md)
+- [doc/create-new-repo.md](doc/create-new-repo.md)
+- [doc/fast-coding-guide.md](doc/fast-coding-guide.md)

package/dist/README.md

@@ -8,17 +8,84 @@ found in the LICENSE file in the root of this package.
 
 # @rljson/server
 
-## Users
+Local-first, pull-by-reference server layer for Rljson. Clients keep writes local, pull data on demand through multis, and let the server proxy references without duplicating client data.
 
-| File                                 | Purpose                     |
-| ------------------------------------ | --------------------------- |
-| [README.public.md](README.public.md) | Install and use the package |
+- Writes stay local; reads cascade: local ➜ server ➜ peers
+- References (hashes) flow; data is pulled on demand
+- Server aggregates sockets and multicasts refs, but only stores what you explicitly import
+- Graceful lifecycle: `tearDown()` for both Server and Client, automatic disconnect cleanup, `removeSocket()` for manual removal
+- Configurable production defaults: ref eviction interval, peer init timeout (server and client)
+- Structured logging via injectable `ServerLogger` (NoopLogger default, ConsoleLogger, BufferedLogger, FilteredLogger included)
+- **Sync protocol**: Optional ACK aggregation, causal ordering with gap-fill, enriched payload forwarding via `SyncConfig`
 
-## Contributors
+## Quick start
 
-| File                                             | Purpose                       |
-| ------------------------------------------------ | ----------------------------- |
-| [README.contributors.md](README.contributors.md) | Run, debug, build and publish |
-| [README.architecture.md](README.architecture.md) | Software architecture guide   |
-| [README.trouble.md](README.trouble.md)           | Errors & solutions            |
-| [README.blog.md](README.blog.md)                 | Blog                          |
+Install:
+
+```sh
+pnpm add @rljson/server
+```
+
+Minimal server:
+
+```ts
+import { BsMem } from '@rljson/bs';
+import { IoMem } from '@rljson/io';
+import { Route } from '@rljson/rljson';
+import { Server, SocketIoBridge } from '@rljson/server';
+
+const route = Route.fromFlat('my.app');
+const serverIo = new IoMem();
+await serverIo.init();
+await serverIo.isReady();
+
+const server = new Server(route, serverIo, new BsMem());
+await server.init();
+
+// When your runtime yields sockets, wrap them:
+// await server.addSocket(new SocketIoBridge(serverSocket));
+```
+
+Minimal client:
+
+```ts
+import { BsMem } from '@rljson/bs';
+import { IoMem } from '@rljson/io';
+import { Client, SocketIoBridge } from '@rljson/server';
+
+// Pass the same route as the server to get Db and Connector automatically
+const route = Route.fromFlat('my.app');
+const client = new Client(new SocketIoBridge(clientSocket), new IoMem(), new BsMem(), route);
+await client.init();
+
+const io = client.io;               // IoMulti merged interface
+const bs = client.bs;               // BsMulti merged interface
+const db = client.db;               // Db (available when route provided)
+const connector = client.connector; // Connector (available when route provided)
+```
+
+Run tests and lint:
+
+```sh
+pnpm test
+```
+
+Build distribution:
+
+```sh
+pnpm build
+```
+
+## Documentation map
+
+| Audience        | File                                             | Highlights                                        |
+| --------------- | ------------------------------------------------ | ------------------------------------------------- |
+| Users           | [README.public.md](README.public.md)             | Install, usage, networking model, examples        |
+| Contributors    | [README.contributors.md](README.contributors.md) | Setup, dev workflow, publishing, fast coding tips |
+| Architecture    | [README.architecture.md](README.architecture.md) | Deep dive into multis, peer bridges, data flows   |
+| Troubleshooting | [README.trouble.md](README.trouble.md)           | Known issues and fixes                            |
+| Blog            | [README.blog.md](README.blog.md)                 | Writing and collecting project blog entries       |
+
+## Example code
+
+See [src/example.ts](src/example.ts) for a runnable end-to-end demo and [test/server.spec.ts](test/server.spec.ts) for broader integration cases.