readme-authoring
CommunityPolish READMEs for fast onboarding.
Authormortenbroesby
Version1.0.0
Installs0
System Documentation
What problem does it solve?
READMEs often lack clear orientation, structured sections, and onboarding guidance, making it hard for new contributors to understand a project quickly.
Core Features & Use Cases
- Create a consistent README structure with a clear introduction, usage, setup, and contribution guidance.
- Identify and fill missing sections, replace vague language with concrete instructions, and standardize formatting to improve onboarding and maintenance.
- Use cases include onboarding new contributors, revamping stale READMEs, and aligning multiple subprojects under a single repo standard.
Quick Start
Draft a polished README that introduces the project, explains how to run it, and links deeper docs.
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-authoring Download link: https://github.com/mortenbroesby/playground/archive/main.zip#readme-authoring 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.