write-readme
CommunityTurn rough ideas into polished README docs.
Authorterencefan
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This workflow solves the problem of turning vague project ideas and scattered notes into coherent, well-structured README documents that communicate boundary, purpose, and usage.
Core Features & Use Cases
- Analyze repository structure to determine the appropriate README boundary (root, module, API, or docs index).
- Load relevant templates from references and preserve existing terminology when rewriting.
- Generate a frontmatter block (name and description) and a ready-to-publish Markdown body based on local context.
Quick Start
Provide the project context and requested boundary, and let this skill produce a ready-to-publish README draft.
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: write-readme Download link: https://github.com/terencefan/inority-workspace/archive/main.zip#write-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 471,000+ vetted skills library on demand.