skills.rest
dmccreary
dmccrearyCOMMUNITY
Explore all skills by this author →
Website𝕏@dmccrearyGitHub

readme-generator

Generate validated GitHub README.md files with badges and site metrics.

90|12|Updated Nov 1, 2025
Search Tags:#documentation#metrics#README#badges
One-click install
npx skills add https://github.com/dmccreary/claude-skills --skill readme-generator-dmccreary
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-generator
Source: https://github.com/dmccreary/claude-skills/tree/main/skills/readme-generator
Command: npx skills add https://github.com/dmccreary/claude-skills --skill readme-generator-dmccreary

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill generates comprehensive README.md files with badges, site metrics, usage, and structure tailored for MkDocs-based textbooks.

Core Features & Use Cases

  • Automatic badge generation and live site links
  • Site metrics collection and embedded usage instructions
  • Validation tooling to ensure quality and consistency

Quick Start

Run the readme-generator against a repository to produce a complete README with badges and usage instructions.

Frequently Asked Questions about readme-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README with badges and metrics for my GitHub repository?▼

Generate README.md files automatically with this Skill, which creates comprehensive documentation including badges, live-site links, project metrics, and getting-started sections tailored to your repository structure and tooling.

Can I use this to create READMEs for MkDocs-based documentation projects?▼

Yes. This Skill is designed for MkDocs-based intelligent textbooks, software libraries, and documentation sites. It analyzes mkdocs.yml and repository context to produce READMEs with relevant badges and usage instructions.

What information does the generated README include?▼

The Skill generates READMEs containing badges, live-site links, project overview, metrics, getting-started instructions, repository structure, licensing details, and contact information validated for GitHub.

What are the technical requirements to run the README generator?▼

The Skill requires Python 3.8 or higher and read access to repository files, including configuration files like mkdocs.yml and dependency manifests, to analyze project context and collect site metrics.

Does the README generator validate the output before publishing?▼

Yes. The Skill includes validation tooling to ensure the generated README meets quality and consistency standards before it's ready for GitHub deployment.

Related Skills

Explore More Software Engineering Skills→
Snowflake-LabsSnowflake-Labs
12

read-ors-configuration

A concise summary of your roleplay character: name,</name> personality, and/or behavior, formatted as a single string sentence. Typically不超过50字，此处省略

Official
Intermediate
GlourGlour

github-publisher

Publish GitHub repositories with bilingual READMEs and validation checklists.

Community
Advanced
moonshineTPmoonshineTP

readme-generator

Generate README.md files with badges and repository metrics for GitHub.

Community
Intermediate
peterfeipeterfei
420

softcopyright

Generate software manuals and source-code documents in HTML and PDF.

Community
Intermediate