ClaudSkills / Engineering / docs-engineering

Crafting Readme Files

Quality score: 70/100  ·  Category: Engineering  ·  Sub-category: docs-engineering
Craft professional README.md files for GitHub open source projects. Generates hero sections, installation instructions, feature tables, and architecture diagrams. Use when creating or revising a README, documenting a CLI tool, library, or open source project, or when user asks about README structure, badges, or project documentation.

What this skill does

Crafting Readme Files is a production-ready Claude Code skill (quality score 70/100) in the docs-engineering sub-category. It ships as a SKILL.md file that Claude Code auto-discovers under ~/.claude/skills/crafting-readme-files/ and loads when your prompt matches the skill's trigger.

When to invoke it: Use when creating or revising a README, documenting a CLI tool, library, or open source project, or when user asks about README structure, badges, or project documentation.

Who uses this skill

The Crafting Readme Files skill is built for software engineers, backend developers, full-stack teams, and technical leads building and maintaining production systems. It is part of the open ClaudSkills registry, a community-curated catalog of 15,000+ capabilities you can install for Claude Code — the Claude CLI agent.

How to install

Free

Manual install (2 steps)

mkdir -p ~/.claude/skills/crafting-readme-files
curl -L https://claudskills.com/skills/crafting-readme-files/SKILL.md \
  -o ~/.claude/skills/crafting-readme-files/SKILL.md

Or just download SKILL.md directly and drop it into ~/.claude/skills/crafting-readme-files/. Claude Code auto-discovers it on next session.

Skills live at ~/.claude/skills/crafting-readme-files/SKILL.md on macOS/Linux, or %USERPROFILE%\.claude\skills\crafting-readme-files\SKILL.md on Windows. See the full install guide for step-by-step instructions.

Pro

One-click install via the desktop app

The ClaudSkills desktop app installs any skill directly into ~/.claude/skills/ with one click — no terminal required. Pro starts at $9/mo or $149 lifetime.

More Engineering skills

Browse all Engineering skills in the ClaudSkills registry, or explore these top-rated picks from the same category:

Browse all Engineering skills → Top 100 skills
Part of ClaudSkills — the open registry for Claude Code skills.  ·  What's New  ·  Install guide  ·  About  ·  llms.txt

Part of Acreator Store — Adam Lankamer's AI tools: GifPerfect · AspectPerfect · SlomoPerfect · Ucaption · UTagger · AutoXPoster · TestYourSkills