¶
Automated Documentation
Generate comprehensive documentation from your codebase instantly
Highly Customizable
Choose from dozens of styling options, badges, and templates
Flexible Backends
Seamlessly integrate with OpenAI
, Anthropic
, Google Gemini
, and Ollama
Language Agnostic
Works with any programming language or framework
Quick Start
1. Install README-AI
pip install readmeai
2. Generate Documentation
readmeai --repository https://github.com/user/project-name --output README-AI.md