Readme Generator

Generates professional README.md files for GitHub repos following best practices, with a focus on MkDocs documentation sites. It analyzes your repo structure, pulls metadata from mkdocs.yml, and builds out badges, project overview, getting started sections, and comprehensive metrics tables. The metrics collection is actually pretty thorough: it counts concepts from learning graphs, tracks MicroSims, tallies quiz questions, and breaks down content by word count and media assets. Nice attention to detail on the badge order too, explicitly noting not to include a pointless self-referencing GitHub repo badge. Good for initial repo setup or bringing an existing README up to standard when your project has grown beyond a quick description.

skills.sh installs: 213
GitHub stars: 90
last updated: Aug 21, 2026

View on GitHub

Install

$ npx -y skills add dmccreary/claude-skills --skill readme-generator --agent claude-code

Installs into .claude/skills of the current project.

Files

README Generator

Generate or update a comprehensive README.md file for GitHub repositories following best practices.

Purpose

This skill automates the creation of professional, well-structured README.md files for GitHub repositories. It generates all essential sections including badges for technologies used, project overview, site metrics, getting started instructions, project structure, and contact information. The skill is particularly optimized for MkDocs-based intelligent textbook projects but can be adapted for any repository type.