From 6335bfe87e015fb14db9153c86db47b7999f4f4b Mon Sep 17 00:00:00 2001 From: Hein Date: Wed, 30 Sep 2026 23:04:56 +0200 Subject: [PATCH] docs(readme): reference all pkg packages and clients --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 5d638a5..89f7139 100644 --- a/README.md +++ b/README.md @@ -491,6 +491,19 @@ Execute SQL functions and queries through a simple HTTP API with header-based pa For complete documentation, see [pkg/funcspec/](pkg/funcspec/). +#### Clients + +All clients are under [clients/](clients/README.md); wire behaviour is identical across them. + +| Client | Language | Specs | Docs | +|---|---|---|---| +| `resolvespec-js` | TypeScript | ResolveSpec, HeaderSpec, FunctionSpec, WebSocketSpec | [README](clients/resolvespec-js/README.md) | +| `resolvespec-python` | Python >= 3.11 | ResolveSpec, HeaderSpec, FunctionSpec, WebSocketSpec | [README](clients/resolvespec-python/README.md) | +| `resolvespec-go` | Go | ResolveSpec, FunctionSpec | [README](clients/resolvespec-go/README.md) | +| `resolvespec-rs` | Rust | ResolveSpec, FunctionSpec | [README](clients/resolvespec-rs/README.md) | +| `resolvespec-cs` | C# (.NET 8) | ResolveSpec, FunctionSpec | [README](clients/resolvespec-cs/README.md) | +| `resolvespec-dart` | Dart / Flutter | ResolveSpec, FunctionSpec | [README](clients/resolvespec-dart/README.md) | + #### ResolveSpec JS - TypeScript Client Library TypeScript/JavaScript client library supporting all three REST and WebSocket protocols. @@ -669,6 +682,23 @@ Configuration management with support for multiple formats and environments. For documentation, see [pkg/config/README.md](pkg/config/README.md). +#### DB Trace + +Per-request DB call counting (`tx`, `tx_queries`, `pooled`, `raw`) and pool logging. Off by default. + +For documentation, see [pkg/dbtrace/README.md](pkg/dbtrace/README.md). + +### Core Libraries + +| Package | Purpose | +|---|---| +| [`pkg/common`](pkg/common/) | Shared interfaces (database, request/response adapters), validation, recursive CRUD, request transactions ([TRANSACTIONS.md](pkg/common/TRANSACTIONS.md)) | +| [`pkg/modelregistry`](pkg/modelregistry/) | Model registration by schema/entity and per-model access rules | +| [`pkg/reflection`](pkg/reflection/) | Model/struct reflection helpers (primary keys, columns, relations) | +| [`pkg/spectypes`](pkg/spectypes/) | SQL-aware types (nullable, JSONB, PostGIS, vector) | +| [`pkg/logger`](pkg/logger/) | Logging used by all packages | +| [`pkg/testmodels`](pkg/testmodels/) | Shared test models and data for tests and the testserver | + ## Security Considerations * Implement proper authentication and authorization