Readme Writer
Generate polished README.md files from your codebase automatically. No more staring at a blank page.
Quick Start
npx ai-readme
What It Does
- Analyzes your codebase structure
- Generates professional README with all sections
- Adds appropriate badges (npm, license, etc.)
- Creates install/usage instructions from your code
- Includes API documentation from your exports
Usage
# Generate README for current project
npx ai-readme
# Output to specific file
npx ai-readme --output ./README.md
Generated Sections
- Project title and description
- Installation instructions
- Usage examples
- API reference
- Contributing guidelines
- License info
Part of the LXGIC Dev Toolkit
One of 110+ free developer tools from LXGIC Studios. No paywalls, no sign-ups.
Find more:
- GitHub: https://github.com/lxgic-studios
- Twitter: https://x.com/lxgicstudios
- Substack: https://lxgicstudios.substack.com
- Website: https://lxgicstudios.com
License
MIT. Free forever.