🤖 readmeai

AI-powered README generator for any project.

readmeai analyzes your project directory and generates a professional README.md using AI. No more staring at a blank page – just run readmeai and get a complete, well-structured README in seconds.

✨ Features

• 🔍 Scans project structure and key configuration files
• 🧠 Uses AI to write a comprehensive README tailored to your project
• 📦 Supports Python, Node.js, Rust, Go, and more
• 🎨 Includes badges, install instructions, usage examples, and contributing guide
• ✍️ Interactive mode: preview before saving
• 🔌 Pluggable AI providers: OpenCode, OpenAI, Ollama
• 🐍 Zero heavy dependencies – only requests

🚀 Quickstart

1. Install

pip install readmeai-py

2. Configure your AI provider (default: OpenCode)

export OPENCODE_API_URL="http://localhost:8080/v1/chat/completions"
export OPENCODE_API_KEY="your-key-here"

For OpenAI:

export OPENAI_API_KEY="sk-..."

For Ollama:

export OLLAMA_API_URL="http://localhost:11434/api/generate"

3. Generate a README

cd your-project
readmeai

Or specify a directory and use interactive mode:

readmeai /path/to/project --interactive

📦 Usage

readmeai [directory] [options]

🔧 Supported AI Providers

🤖 How It Works

1. Recursively scans the project directory (ignoring common junk folders)
2. Collects the file tree and reads important files (e.g., pyproject.toml, package.json)
3. Constructs a summary and sends it to the AI with a specialized prompt
4. The AI returns the full README content, which is written to disk
5. Optionally shows a preview for approval

🛠 Development

Clone and install in editable mode:

git clone https://github.com/erico964-blip/readmeai
cd readmeai
pip install -e .

📜 License

MIT © erico964-blip