skills/skills.volces.com/github-readme-generator

github-readme-generator

Installation
SKILL.md

GitHub README Generator

One-Sentence Description

Automatically generates comprehensive READMEs from GitHub repos including installation instructions, API documentation, and usage examples.

Core Capabilities

  • Analyze GitHub repository structure and extract key information
  • Generate comprehensive README files with proper sections and formatting
  • Create installation instructions based on package.json, requirements.txt, and project structure
  • Generate API documentation from code comments and function signatures
  • Create usage examples from existing code patterns
  • Handle various programming languages and frameworks automatically
  • Provide clean CLI interface for direct usage and agent integration
  • Validate generated READMEs for completeness and quality
  • Handle errors gracefully with meaningful messages and exit codes
Installs
2
First Seen
Apr 21, 2026
github-readme-generator from skills.volces.com