Skip to content

Commit fe26b57

Browse files
committed
[docs] add kyo-sql and kyo-net to the module tables
kyo-sql, kyo-sql-postgres, kyo-sql-mysql, and kyo-net shipped in RC6 but never reached the root README, so they are absent from the module tables and from getkyo.io, which renders its sidebar from those tables. Adds the three SQL modules under Applications and kyo-net under Specialized tools, and names SQL access in the Applications intro. Two corrections found while checking the rest of the tables: - kyo-aeron claimed JVM only. RC6 moved it to one embedded C client on JVM, JS, Native, and Wasm. - The legend said platform columns mean published artifacts. RC6 stopped publishing Wasm, so every Wasm checkmark claimed an artifact that does not exist. The columns now mean supported targets, with the published set named and Wasm's build-and-test-only status stated once. kyo-net carries a Windows dagger: no native transport ships for Windows, so it runs the NIO transport with JDK TLS there.
1 parent 4141310 commit fe26b57

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -285,13 +285,14 @@ These modules work on Windows with a documented limitation, and are marked with
285285
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
286286
| kyo-core | `KyoApp` installs no SIGINT/SIGTERM handler, so shutdown runs no graceful finalization. Everything else is fully supported. |
287287
| kyo-case-app | Shares `KyoApp`'s entrypoint, so the same signal-handling gap applies. |
288+
| kyo-net | No native transport ships for Windows, so it runs the NIO transport with JDK TLS rather than io_uring, kqueue, or BoringSSL. Everything else is fully supported. |
288289
| kyo-stats-machine | `machine.memory.free` is not reported (Windows draws no distinction between free and available memory), and `machine.cpu.system.rate` is derived as kernel time minus idle. |
289290
| kyo-pod | Container operations require a container runtime configured for the images you run; a daemon in Windows-containers mode cannot run Linux images. |
290291
| kyo-browser | Chrome auto-download covers Windows x86_64 but not Windows ARM, for which Google publishes no build; pass a `Browser.LaunchConfig` naming a system-installed Chromium instead. |
291292

292293
## Modules
293294

294-
Every module ships its own README. Open the linked README for the full surface, features, callouts, and worked examples. The tables below name each module's identity in one sentence so you can pick the right one fast. Each identity cell names types and operations defined inside that module; expect unfamiliar names on first scan and treat the linked README as the source for what each one does. Platform columns mean published artifacts: ✅ marks the platforms each module is published for. A † marks a module with a documented Windows limitation, detailed under [Windows support](#windows-support); every module builds and tests on Windows for the JVM and Scala.js targets.
295+
Every module ships its own README. Open the linked README for the full surface, features, callouts, and worked examples. The tables below name each module's identity in one sentence so you can pick the right one fast. Each identity cell names types and operations defined inside that module; expect unfamiliar names on first scan and treat the linked README as the source for what each one does. Platform columns mean supported targets: ✅ marks the platforms each module is built and tested for. JVM, Scala.js, and Scala Native artifacts are published to Maven Central; WebAssembly cross-builds and is tested in CI but ships no published artifact. A † marks a module with a documented Windows limitation, detailed under [Windows support](#windows-support); every module builds and tests on Windows for the JVM and Scala.js targets.
295296

296297
### Core
297298

@@ -307,11 +308,14 @@ What every Kyo program uses. `kyo-core` and `kyo-prelude` carry the effects you
307308

308309
### Applications
309310

310-
The vertical an application developer assembles: HTTP services and clients, derived codecs, runtime config and feature flags, durable workflows, web UIs, and a GraphQL surface.
311+
The vertical an application developer assembles: HTTP services and clients, SQL access, derived codecs, runtime config and feature flags, durable workflows, web UIs, and a GraphQL surface.
311312

312313
| Module | JVM | JS | Native | WASM | Identity |
313314
| -------------------------------------------- | --- | --- | ------ | ---- | ---------------------------------------------------------------------------------------------------------- |
314315
| [kyo-http](kyo-http/README.md) ||||| HTTP/1.1 client and server with shared API across JVM/JS/Native/WASM, bidirectional OpenAPI |
316+
| [kyo-sql](kyo-sql/README.md) ||||| Raw SQL and a typed DSL over one AST; the database is a `DB` dependency in the effect row, no JDBC |
317+
| [kyo-sql-postgres](kyo-sql-postgres/README.md) ||||| PostgreSQL driver speaking the wire protocol on kyo-net, plus `COPY` and `LISTEN`/`NOTIFY` |
318+
| [kyo-sql-mysql](kyo-sql-mysql/README.md) ||||| MySQL driver speaking the wire protocol on kyo-net, plus `LOAD DATA LOCAL INFILE` |
315319
| [kyo-schema](kyo-schema/README.md) ||||| One `derives Schema` powers validation, lenses, diffs, builders, and structural conversion; codecs plug in |
316320
| [kyo-schema-json](kyo-schema-json/README.md) ||||| JSON codec for kyo-schema: `Json.encode`/`decode` text and bytes, safety limits, JSON Schema generation |
317321
| [kyo-schema-protobuf](kyo-schema-protobuf/README.md) ||||| Protocol Buffers codec for kyo-schema: `Protobuf.encode`/`decode` binary plus `.proto` schema export |
@@ -369,7 +373,8 @@ Domain-shaped modules: parsing, durable workflows, container management, low-lat
369373
| [kyo-mcp](kyo-mcp/README.md) ||||| Model Context Protocol client and server built on kyo-jsonrpc with typed tools, prompts, and resources |
370374
| [kyo-lsp](kyo-lsp/README.md) ||||| Language Server Protocol 3.17 servers and clients with typed handlers, documents, progress, and cancel |
371375
| [kyo-compiler](kyo-compiler/README.md) || | | | Scala 3 presentation compiler pool for diagnostics, completions, hover, signatures, and symbols |
372-
| [kyo-aeron](kyo-aeron/README.md) || | | | Typed pub/sub on Aeron: shared-memory IPC, UDP unicast, UDP multicast through one `Topic` API |
376+
| [kyo-aeron](kyo-aeron/README.md) ||||| Typed pub/sub on Aeron: shared-memory IPC, UDP unicast, UDP multicast through one `Topic` API |
377+
| [kyo-net](kyo-net/README.md)||||| TCP, Unix sockets, stdio, and TLS on one C transport: io_uring, epoll, kqueue, NIO, Node, BoringSSL |
373378
| [kyo-ffi](kyo-ffi/README.md) ||||| Bind a C library once with typed Scala signatures; safe calls from JVM (Panama), JS/WASM (koffi), and Native |
374379
| [kyo-tasty](kyo-tasty/README.md) ||||| Cross-platform TASTy reflection over a pure sealed model; Scala 3 reflection without a live JVM |
375380

0 commit comments

Comments
 (0)