← Back to Browse
Documentation
ReadMeAI
Generates beautiful, comprehensive README files by analyzing your codebase structure and documentation.
★★★★☆ 4.4
223 reviews
8.1k
installs
v2.1.0
MIT
Install
npx skilldock install readme-ai
About
ReadMeAI scans your project for package configs, API routes, environment variables, and code comments to generate a complete README with installation instructions, API documentation, environment setup guide, and contribution guidelines. Supports badges, table of contents, and custom templates.
Usage Example
# Generate README from project root
npx readme-ai generate
# With custom template
npx readme-ai generate --template minimal --badges