From b634181649ec9c8fb9ef5b6dab14219f11f45462 Mon Sep 17 00:00:00 2001
From: Ray Walker <ray@27b.io>
Date: Sun, 17 May 2026 12:39:27 +1000
Subject: [PATCH] docs: correct Node.js requirement, add core-ts README,
 bootstrap 0.1.2
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

packages/cachekit/README.md:
- "Requirements: Node.js 18+" was stale; PR #47 bumped engines.node
  to >=22.0.0. README now matches.
- Added a version-history note explaining 0.1.0 → 0.1.2 on npm so
  consumers don't think 0.1.1 is missing or yanked.

packages/cachekit-core-ts/README.md (new):
- Every npm-published package should have a README; this one had
  none. Added a minimal one describing platform packages, API
  surface, and the same 0.1.0 → 0.1.2 version note.

This commit touches both packages/ paths so release-please picks
them up as a coordinated release. The Release-As: 0.1.2 footer
skips 0.1.1 (which exists as a git tag but never reached npm due
to bugs fixed in PR #45 and PR #51) and goes straight to 0.1.2 —
keeping version monotonicity between the manifest, git tags, and
npm.

Release-As: 0.1.2
---
 packages/cachekit-core-ts/README.md | 47 +++++++++++++++++++++++++++++
 packages/cachekit/README.md         |  4 ++-
 2 files changed, 50 insertions(+), 1 deletion(-)
 create mode 100644 packages/cachekit-core-ts/README.md

diff --git a/packages/cachekit-core-ts/README.md b/packages/cachekit-core-ts/README.md
new file mode 100644
index 0000000..cef5567
--- /dev/null
+++ b/packages/cachekit-core-ts/README.md
@@ -0,0 +1,47 @@
+# @cachekit-io/cachekit-core-ts
+
+Native Rust bindings for [`@cachekit-io/cachekit`](https://www.npmjs.com/package/@cachekit-io/cachekit). Provides byte-storage (LZ4 + xxHash3), HKDF key derivation, and AES-256-GCM encryption primitives via N-API.
+
+> **Version note**: 0.1.1 was tagged in git but never published to npm (a CI flag-rename bug in @napi-rs/cli v3, fixed in #51). Published versions on npm jump 0.1.0 → 0.1.2. If you're pinning, use 0.1.2 or later.
+
+## Installation
+
+You shouldn't need to install this directly — it's a peer of `@cachekit-io/cachekit`. Installing the main SDK pulls in the right platform binary automatically:
+
+```bash
+npm install @cachekit-io/cachekit
+```
+
+## Platform support
+
+Prebuilt binaries are shipped via per-platform npm packages, selected at install time by the `optionalDependencies` mechanism:
+
+| Platform              | Target                      | Package                                         |
+| --------------------- | --------------------------- | ----------------------------------------------- |
+| Linux x86_64 (glibc)  | `x86_64-unknown-linux-gnu`  | `@cachekit-io/cachekit-core-ts-linux-x64-gnu`   |
+| Linux aarch64 (glibc) | `aarch64-unknown-linux-gnu` | `@cachekit-io/cachekit-core-ts-linux-arm64-gnu` |
+| macOS x86_64          | `x86_64-apple-darwin`       | `@cachekit-io/cachekit-core-ts-darwin-x64`      |
+| macOS arm64           | `aarch64-apple-darwin`      | `@cachekit-io/cachekit-core-ts-darwin-arm64`    |
+| Windows x86_64 (MSVC) | `x86_64-pc-windows-msvc`    | `@cachekit-io/cachekit-core-ts-win32-x64-msvc`  |
+
+If your platform isn't listed, the package will fail to load at runtime. Open an issue if you need an additional target.
+
+## API surface
+
+Public exports (consumed by `@cachekit-io/cachekit`):
+
+- `ByteStorage` — LZ4 compression + xxHash3-64 integrity envelope
+- `TenantKeys` — HKDF-SHA256 per-tenant derived keys with `ZeroizeOnDrop`
+- `deriveKey` — single-domain HKDF key derivation
+- `encrypt` / `decrypt` — AES-256-GCM with AAD binding
+- `version` — version string from the underlying Cargo crate
+
+See the [main SDK README](https://www.npmjs.com/package/@cachekit-io/cachekit) for usage; this package isn't intended for direct consumption.
+
+## Requirements
+
+- Node.js 22+
+
+## License
+
+MIT
diff --git a/packages/cachekit/README.md b/packages/cachekit/README.md
index e354805..d270f3b 100644
--- a/packages/cachekit/README.md
+++ b/packages/cachekit/README.md
@@ -2,6 +2,8 @@
 
 Production-ready Redis caching for TypeScript/Node.js. Hybrid TypeScript-Rust design with L1 in-memory cache, SWR, circuit breaker, and optional client-side encryption.
 
+> **Version note**: 0.1.1 was tagged in git but never published to npm (a CI auth bug, fixed in #45). Published versions on npm jump 0.1.0 → 0.1.2. If you're pinning, use 0.1.2 or later.
+
 ## Features
 
 - **Dual-layer caching**: L1 in-memory (~50ns) + L2 Redis (~2-50ms)
@@ -225,7 +227,7 @@ const cache = createCache({
 
 ## Requirements
 
-- Node.js 18+
+- Node.js 22+
 - Redis 6+
 
 ## License