draft-repo-readme
CommunityDraft honest, source-based repo READMEs.
Authornholder88
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Drafting a faithful README for a single repository is hard when details come from the repo itself; this skill eliminates guesswork by pulling from the repo's own files and history to avoid invented details.
Core Features & Use Cases
- Grounded README generation: reads manifest files (package.json, pyproject.toml, Cargo.toml, etc.) and key directories to craft an honest overview.
- Structured template application: follows the standard readme-template guidance to present Problem, Goal, Approach, Implemented Features, and Getting Started.
- Provenance and auditability: cites commits and file structure to back up the content and enables easy updates as the repo evolves.
Quick Start
Run the draft-repo-readme skill on a target repository to generate a draft README in _drafts/<repo>/README.md.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 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: draft-repo-readme Download link: https://github.com/nholder88/ai-agent-workflows/archive/main.zip#draft-repo-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 510,000+ vetted skills library on demand.