| name | readme |
| description | Generate or update a comprehensive README.md for the project. Use when the user asks to create, update, or improve the README. |
README Generator
Generate a thorough, well-structured README.md for bitsocial-react-hooks.
Key Sections
- Header — project name, badges, one-line description
- Overview — what the library does and why it exists
- Installation — how to install
- Quick Start — minimal working example
- API Reference — hooks and utilities with signatures
- Testing — how to run tests
- Contributing — development workflow
- License
Writing Principles
- Be thorough — every command should be copy-pasteable
- Use code blocks with language hints (
typescript, bash)
- Keep the public API reference in sync with
src/index.ts
- Use tables for structured reference data
- Write for someone who has never seen this codebase
Output
Write the README directly to README.md in the project root.