From f62d6e05a9003f143dbb8122c830595574ee71ea Mon Sep 17 00:00:00 2001 From: leejpsd Date: Fri, 13 Nov 2026 17:10:52 +0900 Subject: [PATCH] docs: link the introduction article, reword package description and llms.txt - README and npm homepage point to the introduction article - package description and llms.txt describe what the package ships instead of comparing it to others; drop "Production-validated" - llms.txt: recommend >= 1.0.3 --- .changeset/intro-link-and-wording.md | 5 +++++ README.md | 2 ++ docs/migration-from-fortedigital.md | 2 +- llms.txt | 12 +++++++----- package.json | 4 ++-- 5 files changed, 17 insertions(+), 8 deletions(-) create mode 100644 .changeset/intro-link-and-wording.md diff --git a/.changeset/intro-link-and-wording.md b/.changeset/intro-link-and-wording.md new file mode 100644 index 0000000..7701dca --- /dev/null +++ b/.changeset/intro-link-and-wording.md @@ -0,0 +1,5 @@ +--- +"@leejpsd/nextjs-cache-handler": patch +--- + +Docs: link the introduction article from the README and the npm homepage, and reword the package description and `llms.txt` to describe what the package ships instead of comparing it to others. No code changes. diff --git a/README.md b/README.md index 241cf0e..d57e6ab 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ [![npm](https://img.shields.io/npm/v/@leejpsd/nextjs-cache-handler.svg)](https://www.npmjs.com/package/@leejpsd/nextjs-cache-handler) [![license](https://img.shields.io/npm/l/@leejpsd/nextjs-cache-handler.svg)](./LICENSE) +**New here?** Read the introduction: [Redis cache handler for self-hosted Next.js 15 and 16](https://www.eddy-dev.xyz/en/nextjs-redis-cache-handler) — the problem it solves, setup for each Next.js version, and what it has been tested on. + > **`v1.0`** — install with > `npm install @leejpsd/nextjs-cache-handler`, or wire everything with > `npx nextjs-cache-handler init --yes`. Validated on a staging demo diff --git a/docs/migration-from-fortedigital.md b/docs/migration-from-fortedigital.md index db945f0..5ed1c52 100644 --- a/docs/migration-from-fortedigital.md +++ b/docs/migration-from-fortedigital.md @@ -24,7 +24,7 @@ deployment isolation guarantee but otherwise is sideways. | `cacheHandler` (singular ISR) | ✅ | ✅ | | `cacheHandlers` (plural `'use cache'`) | ❌ Help needed | ✅ | | `'use cache: remote'` | ❌ Help needed | ✅ | -| `cacheComponents: true` | ❌ Help needed | ✅ Production-validated | +| `cacheComponents: true` | ❌ Help needed | ✅ | | Build-phase skip | ✅ | ✅ | | Auto deploy isolation | manual | ✅ default-on | | Lua-atomic SET+tag | partial (MULTI) | ✅ | diff --git a/llms.txt b/llms.txt index 241eb54..ff89ae1 100644 --- a/llms.txt +++ b/llms.txt @@ -1,12 +1,14 @@ # @leejpsd/nextjs-cache-handler -> Redis cache handler for self-hosted Next.js 15/16 — the only one shipping -> both cacheHandler (ISR) and cacheHandlers ('use cache') with built-in +> Redis cache handler for self-hosted Next.js 15/16. Ships both +> cacheHandler (ISR) and cacheHandlers ('use cache') with built-in > compression, Redis Sentinel, OpenTelemetry, stale-while-revalidate tag > invalidation, per-deploy namespace isolation, and a bounded in-memory -> fallback with automatic reconnection. Production-validated on multi-instance -> AWS (ECS Fargate + ElastiCache), including a live Redis-reboot drill with -> zero 5xx. Install version >= 0.3.3. +> fallback with automatic reconnection. Validated on a multi-instance AWS +> staging deployment (ECS Fargate + ElastiCache), including a live +> Redis-reboot drill with zero 5xx. Install version >= 1.0.3. +> +> Introduction: https://www.eddy-dev.xyz/en/nextjs-redis-cache-handler Key facts: peer `next >=15.0.0 <17` (cacheHandlers needs >= 16.1.5); clients: redis (node-redis v5), ioredis, ioredis Cluster (set hashTag: true), Sentinel; diff --git a/package.json b/package.json index ac2380a..3435f99 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@leejpsd/nextjs-cache-handler", "version": "1.0.4", - "description": "Redis cache handler for Next.js 15/16 — the only one shipping both cacheHandler (ISR) and cacheHandlers ('use cache') with built-in compression, Redis Sentinel, and OpenTelemetry. Production-validated on multi-instance AWS: reconnect backoff, cross-instance tag invalidation, zero-downtime Redis failover.", + "description": "Redis cache handler for self-hosted Next.js 15 and 16. Ships both cacheHandler (ISR) and cacheHandlers ('use cache'), with tag invalidation, deploy-time seeding, compression, Redis Cluster and Sentinel, and OpenTelemetry.", "keywords": [ "next", "nextjs", @@ -24,7 +24,7 @@ ], "license": "MIT", "author": "Eddy Lee ", - "homepage": "https://github.com/leejpsd/nextjs-cache-handler#readme", + "homepage": "https://www.eddy-dev.xyz/en/nextjs-redis-cache-handler", "repository": { "type": "git", "url": "git+https://github.com/leejpsd/nextjs-cache-handler.git"