writing-readme

Community

Streamlined README creation and review.

AuthorConradmaker
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Keeping READMEs consistent, audience-aware, and aligned with repo reality is time-consuming and error-prone.

Core Features & Use Cases

  • Template-driven discovery: selects the appropriate README template based on the project's type and target audience.
  • Minimal, essential structure: ensures the README includes only necessary sections with clear guidance for updates.
  • Repo-state validation guidance: prompts checks against installation, usage, and contribution aspects to maintain correctness.

Quick Start

Generate a template-based README draft tailored to the repository and its audience, including core sections and guidance for follow-up reviews.

Dependency Matrix

Required Modules

None required

Components

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: writing-readme
Download link: https://github.com/Conradmaker/copilot-cockpit/archive/main.zip#writing-readme

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.