docs-generate-readme
CommunityAuto-generates Level 1 READMEs from design docs.
Authorspencerbeggs
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This skill automates the creation and updating of Level 1 READMEs for npm/GitHub packages by deriving content from design docs and package metadata.
Core Features & Use Cases
- Extract design docs to populate overview, features, and API summaries.
- Incorporate package.json metadata (name, version, description, license) into README.
- Apply transformation rules to present user-friendly content.
- Update existing READMEs while preserving custom sections and assets.
- Validate output against Level 1 quality standards (word count, sections, links).
Quick Start
Generate a Level 1 README for a module by running the docs-generate-readme skill with the module name.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: docs-generate-readme Download link: https://github.com/spencerbeggs/claude-design-coordinator/archive/main.zip#docs-generate-readme Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.