A Claude Code skill that generates polished, shareable GitHub READMEs for any project — structured with banners, badges, comparison tables, quick start guides, and architecture diagrams.
Point it at any project directory or GitHub repo and it generates a complete README with:
- Banner + tagline at the top
- Badges (platform, language, license, download)
- "Why this exists?" comparison table
- Feature list with clean bullet points
- Quick Start in 3 steps or fewer
- Architecture diagram (ASCII or description)
- Comparison table against alternatives
- Contributing and License sections
The output adapts to project size — a small script gets a concise README, a full app gets the works.
- Claude Code CLI installed
- GitHub CLI (
gh) authenticated (for repo-based generation)
User-level (available in all projects):
git clone https://github.com/Ublaze/github-readme-generator.git ~/.claude/skills/github-readme-generatorProject-level (available only in one project):
git clone https://github.com/Ublaze/github-readme-generator.git .claude/skills/github-readme-generatorIn any Claude Code session:
/readme-template D:\Projects\MyNewTool
/readme-template my-github-repo-name
/readme-template https://github.com/user/repo
Claude will:
- Analyze your project (code, dependencies, existing README)
- Generate a complete README in the proven structure
- Present it in a code block for you to copy
- Suggest missing assets (banner, screenshots, social preview)
The generated README follows a battle-tested structure:
Banner / Hero Image
One-line tagline
Badges (platform, language, license, download)
---
Introduction paragraph
Screenshot
"Why this exists?" comparison table
Features (bullet points)
Quick Start (3 steps)
How It Works (architecture)
Configuration
Comparison table (vs alternatives)
System Requirements
Building from Source
Contributing
License
Sections are included or excluded based on project complexity.
Before:
# MyTool
A tool that does stuff. Run `python main.py`.After: A full README with banner placeholder, badges, feature list, comparison table, quick start, architecture diagram, and more — ready to make your repo look professional.
MIT