Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
<img src="https://img.shields.io/badge/tree--shakable-0A0D12?style=for-the-badge" alt="tree-shakable" />
<img src="https://img.shields.io/badge/ESM_%2B_CJS-61DAFB?style=for-the-badge" alt="ESM + CJS" />
<img src="https://img.shields.io/badge/65_hooks-0A0D12?style=for-the-badge" alt="65 hooks" />
<img src="https://img.shields.io/badge/AI--ready-61DAFB?style=for-the-badge" alt="AI-ready" />
</p>

<p align="center">
Expand Down Expand Up @@ -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 |

<sub>Counts as of September 2026 (usehooks-ts v3.1.1). Both are solid β€” pick what fits your project.</sub>

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**,
Expand All @@ -87,6 +104,8 @@ function Component() {
## πŸͺ Available hooks

> πŸ“š Full docs with a **page per hook** and **live demos**: <https://hookli.vercel.app/docs>
>
> πŸ€– 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.

<!-- HOOKS:START β€” generated from hooks.manifest.json (run `node scripts/gen-readme.mjs`); do not edit by hand -->

Expand Down
19 changes: 19 additions & 0 deletions packages/hookli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
<img src="https://img.shields.io/badge/tree--shakable-0A0D12?style=for-the-badge" alt="tree-shakable" />
<img src="https://img.shields.io/badge/ESM_%2B_CJS-61DAFB?style=for-the-badge" alt="ESM + CJS" />
<img src="https://img.shields.io/badge/65_hooks-0A0D12?style=for-the-badge" alt="65 hooks" />
<img src="https://img.shields.io/badge/AI--ready-61DAFB?style=for-the-badge" alt="AI-ready" />
</p>

<p align="center">
Expand Down Expand Up @@ -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 |

<sub>Counts as of September 2026 (usehooks-ts v3.1.1). Both are solid β€” pick what fits your project.</sub>

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**,
Expand All @@ -85,6 +102,8 @@ function Component() {
## πŸͺ Available hooks

> πŸ“š Full docs with a **page per hook** and **live demos**: <https://hookli.vercel.app/docs>
>
> πŸ€– 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.

<!-- HOOKS:START β€” generated from hooks.manifest.json (run `node scripts/gen-readme.mjs`); do not edit by hand -->

Expand Down
Loading