readme

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

1. Header — project name, badges, one-line description
2. Overview — what the library does and why it exists
3. Installation — how to install
4. Quick Start — minimal working example
5. API Reference — hooks and utilities with signatures
6. Testing — how to run tests
7. Contributing — development workflow
8. License

Writing Principles

1. Be thorough — every command should be copy-pasteable
2. Use code blocks with language hints (typescript, bash)
3. Keep the public API reference in sync with src/index.ts
4. Use tables for structured reference data
5. Write for someone who has never seen this codebase

Output

Write the README directly to README.md in the project root.