readme-writing

Community

Auto-generate polished READMEs for projects

Authorkaptinlin
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Generating clear, consistent README.md files for libraries and projects to reduce manual writing effort.

Core Features & Use Cases

  • Template-driven: Generates README sections like installation, quick start, features, usage, and contribution.
  • Documentation standards: Enforces a readable, human-friendly structure aligned with best practices.
  • Project bootstrap scenarios: Useful during new library setup, updates, or doc reviews.

Quick Start

Generate a complete README.md for a given project or library following the template.

Dependency Matrix

Required Modules

None required

Components

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

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.