GitHub README Generator
Pricing
from $0.00001 / actor start
Go to Apify Store
GitHub README Generator
Generates professional README.md files for any public GitHub repository using AI. Just provide a repo URL and get a complete, well-structured README with badges, installation instructions, usage examples, and more.
GitHub README Generator 🚀
An Apify Actor that generates professional README.md files for any public GitHub repository using AI.
Features
- AI-Powered: Uses OpenRouter LLMs to write natural, well-structured READMEs
- Multiple Styles: Professional, playful, minimal, or detailed
- Rich Metadata: Fetches stars, forks, languages, topics, and recent commits
- Smart Fallback: Falls back to a template if LLM is unavailable
- Badge Support: Optional GitHub badges for quick visual status
Input
| Field | Type | Required | Description |
|---|---|---|---|
| repoUrl | string | ✅ | GitHub repository URL |
| style | string | ❌ | README style (professional, playful, minimal, detailed) |
| includeBadges | boolean | ❌ | Include GitHub badges |
Output
The Actor pushes a dataset entry with:
repo— Full repository namereadme— Generated README markdown contentstyle— Style usedstats— Repository statistics
Example Use Cases
- Open source maintainers who want a quick README
- Developers evaluating repos who want better documentation
- AI agents that need to summarize repositories