write-readme

Writing

116 downloads · by community

Generate a README from your package.json, scripts, and source layout

Install

npx @claudeskill/cli install write-readme

What this skill does

Generates a README.md from your package.json, scripts, source layout, and existing docs. Produces sections for install, quick start, configuration, scripts, and contributing, and keeps each section short and concrete. Supports updating an existing README in place rather than overwriting it.

Use cases

Bootstrapping the README for a new package
Updating an out-of-date README after a major refactor
Standardising README structure across many repos
Documenting CLI flags and environment variables

Related skills

humanizer

Remove signs of AI-generated writing from documentation and content

explain-code

Walk through a function or file line by line in plain language

← Back to skills directory