ventiws 1.0.0-beta.5 → 1.0.0-rc.0

package/README.md

@@ -12,7 +12,7 @@ observable behaviour rather than its source. ventiws is not affiliated with the
 as the pinned contract, credited in
 [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
 
-**ventiws is at `1.0.0-beta.5`.** The surface may change between beta
+**ventiws is at `1.0.0-rc.0`.** The surface may change between beta
 releases. What "beta" means here is bounded: the `ws` compatibility
 contract is tracked row by row in
 [COMPATIBILITY.md](COMPATIBILITY.md), and the four places ventiws knowingly
@@ -94,6 +94,14 @@ Both halves run against a real `ws` peer in this repository's suites, and the
 constructors are plain functions returning state records: no `class`, no `this`,
 no prototype.
 
+### Examples
+
+[examples/](examples/) holds the same echo server and client for Node.js, Bun,
+and Deno, each a standalone project with a `package.json` and no build step:
+Node.js strips the types itself, and Bun and Deno run TypeScript natively. The
+commands, and the permissions Deno needs, are in
+[examples/README.md](examples/README.md).
+
 ### Dev logger
 
 ventiws prints lifecycle records as they happen: the splash when a server starts
@@ -169,6 +177,7 @@ pnpm format:check
 - [CODING_CONVENTION.md](CODING_CONVENTION.md): TypeScript and Zig style, the anti-OOP rules, and the module budget.
 - [docs/migrating.md](docs/migrating.md): moving an existing `ws` application over.
 - [docs/logging.md](docs/logging.md): the opt-in dev logger and startup splash.
+- [docs/performance.md](docs/performance.md): the benchmark harness, its fairness rules, and the durable benchmark-data history.
 - [CONTRIBUTE.md](CONTRIBUTE.md): environment setup, the script contract, and how to release.
 
 MIT. See [LICENSE](LICENSE). `ws` is copyright Einar Otto Stangvik, Arnout