readme-craft
CommunityRewrite READMEs for fast, clear adoption.
Content & Communication#documentation#writing#readme#project-docs#ux-writing#documentation-audit#readme-quality
Authorprateek
Version1.0.0
Installs0
System Documentation
What problem does it solve?
READMEs often become bloated or misaligned with product goals. Readme Craft provides a structured method to write, rewrite, or audit READMEs to accelerate onboarding and reduce decision fatigue for users and contributors.
Core Features & Use Cases
- Establish a concise information hierarchy (billboard, first 29 lines) to capture attention and convey value quickly.
- Provide greenfield and rewrite workflows with explicit guidance to trim config dumps, move content to docs, and separate user content from contributor-facing content.
- Offer a practical audit checklist and workflow for improving readability, consistency, and adoption across projects.
Quick Start
Rewrite the README to follow the recommended hierarchy, trim unnecessary content, and clearly separate user-facing guidance from contributor-facing information.
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: readme-craft Download link: https://github.com/prateek/dotfiles/archive/main.zip#readme-craft 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.