GitHub README Generator avatar

GitHub README Generator

Pricing

from $0.00001 / actor start

Go to Apify Store
GitHub README Generator

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.

Pricing

from $0.00001 / actor start

Rating

0.0

(0)

Developer

Ray Pablo

Ray Pablo

Maintained by Community

Actor stats

0

Bookmarked

2

Total users

1

Monthly active users

2 days ago

Last modified

Categories

Share

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

FieldTypeRequiredDescription
repoUrlstringGitHub repository URL
stylestringREADME style (professional, playful, minimal, detailed)
includeBadgesbooleanInclude GitHub badges

Output

The Actor pushes a dataset entry with:

  • repo — Full repository name
  • readme — Generated README markdown content
  • style — Style used
  • stats — 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