readme-generator

Installation
SKILL.md

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.

When to Use This Skill

Use this skill when:

  • Starting a new GitHub repository that needs a README.md
  • Updating an existing README.md to follow best practices
  • After significant project changes that should be documented
  • Before publishing or sharing a repository
  • When migrating from another documentation system
  • After adding new technologies or dependencies
Related skills

More from vishalsachdev/claude-skills

Installs
3
GitHub Stars
2
First Seen
Jan 28, 2026