From 7b62892002f8607d814c90be4a47adff18cd3dd7 Mon Sep 17 00:00:00 2001 From: saifmohamedsv Date: Thu, 3 Sep 2026 00:46:10 +0300 Subject: [PATCH] docs(readme): advertise AI-ready docs + add hookli-vs-usehooks-ts table - AI-ready is now surfaced across the READMEs: an AI-ready pill, a differentiator bullet, and a callout in the hooks section pointing at the now-live /llms.txt, /llms-full.txt and per-page Copy-for-AI. - Add an honest hookli vs usehooks-ts comparison table (verified against usehooks-ts v3.1.1: ~33 hooks, runtime dep lodash.debounce, MIT). Ties shown fairly; hookli's real edges are hook count, zero deps and AI-ready docs. Co-Authored-By: Claude Opus 4.8 Claude-Session: https://claude.ai/code/session_01AuT9BTjvgatPxvkXSPSo1i --- README.md | 19 +++++++++++++++++++ packages/hookli/README.md | 19 +++++++++++++++++++ 2 files changed, 38 insertions(+) diff --git a/README.md b/README.md index a6f9f93..104a93c 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ tree-shakable ESM + CJS 65 hooks + AI-ready

@@ -63,10 +64,26 @@ What sets hookli apart from similar libraries (including [usehooks-ts](https://u - **Zero runtime dependencies** — not just "small deps," literally none besides React. - **SSR-safe by convention** — every hook guards browser APIs; safe in Next.js and Remix. +- **AI-ready docs** — every hook is published as Markdown for LLMs ([`/llms.txt`](https://hookli.vercel.app/llms.txt), [`/llms-full.txt`](https://hookli.vercel.app/llms-full.txt)) with a **Copy for AI** button on each page. - **Manifest-driven docs** — README, hook count, and the docs site all derive from one source of truth. - **Live demos on the real package** — the docs import from npm, not a fork or snapshot. - **Every hook tested** — colocated vitest tests and a CI gate on every PR. +### hookli vs usehooks-ts + +| | hookli | usehooks-ts | +| ---------------------------------------- | :---------------: | :----------------: | +| Hooks | **65** | ~33 | +| Runtime dependencies | **0** | `lodash.debounce` | +| Written in TypeScript | ✅ | ✅ | +| Tree-shakable (ESM) | ✅ | ✅ | +| SSR-safe | ✅ | ✅ | +| AI-ready docs (`llms.txt` + Copy for AI) | ✅ | — | +| Live demos run the published npm build | ✅ | — | +| License | ISC | MIT | + +Counts as of September 2026 (usehooks-ts v3.1.1). Both are solid — pick what fits your project. + The library is designed to be as minimal as possible. It is fully **tree-shakable** (via the ESM build), meaning you only ship the hooks you import and the rest is removed from your bundle — the cost of adding hookli is negligible. Every hook is **typed** and **SSR-safe**, @@ -87,6 +104,8 @@ function Component() { ## 🪝 Available hooks > 📚 Full docs with a **page per hook** and **live demos**: +> +> 🤖 Using an AI assistant? Point it at [`/llms.txt`](https://hookli.vercel.app/llms.txt) or [`/llms-full.txt`](https://hookli.vercel.app/llms-full.txt), or hit **Copy for AI** on any hook page. diff --git a/packages/hookli/README.md b/packages/hookli/README.md index 2fc5ae8..5c92bb8 100644 --- a/packages/hookli/README.md +++ b/packages/hookli/README.md @@ -30,6 +30,7 @@ tree-shakable ESM + CJS 65 hooks + AI-ready

@@ -61,10 +62,26 @@ What sets hookli apart from similar libraries (including [usehooks-ts](https://u - **Zero runtime dependencies** — not just "small deps," literally none besides React. - **SSR-safe by convention** — every hook guards browser APIs; safe in Next.js and Remix. +- **AI-ready docs** — every hook is published as Markdown for LLMs ([`/llms.txt`](https://hookli.vercel.app/llms.txt), [`/llms-full.txt`](https://hookli.vercel.app/llms-full.txt)) with a **Copy for AI** button on each page. - **Manifest-driven docs** — README, hook count, and the docs site all derive from one source of truth. - **Live demos on the real package** — the docs import from npm, not a fork or snapshot. - **Every hook tested** — colocated vitest tests and a CI gate on every PR. +### hookli vs usehooks-ts + +| | hookli | usehooks-ts | +| ---------------------------------------- | :---------------: | :----------------: | +| Hooks | **65** | ~33 | +| Runtime dependencies | **0** | `lodash.debounce` | +| Written in TypeScript | ✅ | ✅ | +| Tree-shakable (ESM) | ✅ | ✅ | +| SSR-safe | ✅ | ✅ | +| AI-ready docs (`llms.txt` + Copy for AI) | ✅ | — | +| Live demos run the published npm build | ✅ | — | +| License | ISC | MIT | + +Counts as of September 2026 (usehooks-ts v3.1.1). Both are solid — pick what fits your project. + The library is designed to be as minimal as possible. It is fully **tree-shakable** (via the ESM build), meaning you only ship the hooks you import and the rest is removed from your bundle — the cost of adding hookli is negligible. Every hook is **typed** and **SSR-safe**, @@ -85,6 +102,8 @@ function Component() { ## 🪝 Available hooks > 📚 Full docs with a **page per hook** and **live demos**: +> +> 🤖 Using an AI assistant? Point it at [`/llms.txt`](https://hookli.vercel.app/llms.txt) or [`/llms-full.txt`](https://hookli.vercel.app/llms-full.txt), or hit **Copy for AI** on any hook page.