¶
Your AI-Powered Documentation Assistant
Designed for simplicity, customization, and developer productivity.
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, Gemini, and Ollama
Language Agnostic
Works with any programming language or framework
Quick Start
1. In the terminal, install the readmeai package:
pip install readmeai2. Once installed, try it out:
readmeai --help3. Generate a README file for your project:
readmeai --repository https://github.com/your-username/your-repo