Skip to content

docs(readme): advertise AI-ready docs + hookli-vs-usehooks-ts table - #9

Merged
devsaifmohamed merged 1 commit into
mainfrom
docs/readme-ai-and-comparison
Sep 2, 2026
Merged

devsaifmohamed merged 1 commit into
mainfrom
docs/readme-ai-and-comparison

Conversation

@devsaifmohamed

Copy link
Copy Markdown
Owner

Builds on #8. Two additions to the README (npm + GitHub landing).

AI-ready "catch"

The AI-friendly docs are now live (/llms.txt, /llms-full.txt, per-hook /docs/<slug>/llms.txt, and Copy-for-AI all return 200 on hookli.vercel.app), so the README now advertises it:

  • an AI-ready feature pill in the badge strip,
  • an AI-ready docs bullet in the differentiators,
  • a 🤖 callout in the hooks section linking /llms.txt + /llms-full.txt and mentioning Copy for AI.

hookli vs usehooks-ts table

An honest comparison, verified against usehooks-ts v3.1.1 (npm): ~33 hooks, one runtime dep (lodash.debounce), MIT. Ties (TypeScript, tree-shakable, SSR) shown fairly as ✅/✅; hookli's genuine edges — 65 hooks, zero deps, AI-ready docs, demos running the published build — stand out. Footnoted + dated so numbers don't silently rot.

Gate green: bash ralph/check.sh — 196 tests, typecheck + build pass.

Merge this before the version patch and one publish carries the badge fix (#8), the grouped index, the AI catch and the table together.

🤖 Generated with Claude Code

- 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 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AuT9BTjvgatPxvkXSPSo1i
@vercel

vercel Bot commented Sep 2, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
hookli Ready Ready Preview Sep 2, 2026 9:46pm UTC

@coderabbitai

coderabbitai Bot commented Sep 2, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 17 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 13f4ae1f-e755-4666-b262-030b3e98be30

📥 Commits

Reviewing files that changed from the base of the PR and between f2b3e8a and 7b62892.

📒 Files selected for processing (2)
  • README.md
  • packages/hookli/README.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@devsaifmohamed
devsaifmohamed merged commit 4cbade2 into main Sep 2, 2026
4 checks passed

This branch was successfully deployed

1 active deployment
Preview — 7b628920 Deployed Sep 2, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant