You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update README: remove line numbers, restructure repo overview
- Remove fragile line number references from bindings section
- Split 'What else is in the repo' into Bindings and Examples subsections
- Add details about each binding file's contents
- Make descriptions more scannable
- where a reducer is built as `Reducer.make(~initial, ~add, ~remove=?)`
@@ -179,11 +179,19 @@ npm run build && node examples/LiveHarness.res.js
179
179
```
180
180
181
181
## What else is in the repo
182
-
-**Bindings**: `bindings/Skipruntime*.res` plus `bindings/SkipruntimeCoreHelpers.mjs` (class constructors, enums, SSE helpers including `subscribeSSE` for streaming updates).
183
-
-**`examples/Example.res`**: Tiny binding smoke (LoadStatus, error ctor, mapper/reducer wiring) without starting the runtime.
184
-
-**`examples/NotifierExample.res`**: Demonstrates notifier callbacks receiving collection updates and watermarks without wiring a full service.
185
-
-**`examples/LiveHarness.res` + `LiveHarnessService.*`**: Demonstrates `map` and `reduce` semantics with `numbers`, `doubled`, and `sum` resources. Includes a client-side O(1) accumulator that subscribes to SSE to receive updates—showing how to layer efficient aggregates on top of reactive data.
186
-
-**`examples/LiveService.*`**: The minimal reactive service definition used by `LiveClient.res` (typed in TS, emitted as JS). Service files are TS for class-heavy definitions and type checks; compiled JS is used at runtime.
-**`SkipruntimeServer.res`**: `runService` to start HTTP/SSE servers.
187
+
-**`SkipruntimeCoreHelpers.mjs`**: JS helpers for class constructors, enums, and SSE utilities (`subscribeSSE` for streaming).
188
+
189
+
### Examples (`examples/`)
190
+
-**`LiveClient.res`**: Main demo—starts a service, reads/updates via HTTP, subscribes via SSE.
191
+
-**`LiveHarness.res` + `LiveHarnessService.ts`**: Demonstrates `map` and `reduce` semantics. Includes `ClientSum`, a client-side O(1) accumulator that subscribes to SSE.
192
+
-**`Example.res`**: Binding smoke test—`LoadStatus`, errors, mapper/reducer wiring—without starting the runtime.
193
+
-**`NotifierExample.res`**: Demonstrates notifier callbacks receiving collection updates and watermarks.
194
+
-**`LiveService.ts`**: Minimal service definition for `LiveClient` (echo resource mirroring input).
0 commit comments