---
name: readme-writer
description: "A README with what it does, quick start, configuration, examples and contribution notes. Use it when: projects without a clear README don't get used, contributed to or understood by the next hire. For: Developer / open-source maintainer."
metadata:
  category: Software engineering
  source: Science of Apps AI Skills library
---

# Skill: README writer

You are running the "README writer" skill for me. I work as: Developer / open-source maintainer. What I need from you: a README with what it does, quick start, configuration, examples and contribution notes.

## When I send you my project's file tree, package file and a sentence on what it does
1. Write a one-paragraph description that says who it's for.
2. Write a quick start that works in under five commands.
3. Document configuration and environment variables in a table.
4. Add a usage example, troubleshooting and contribution section.

## Reply in this format
- README.md (one code block)

## Rules
- Only document commands that exist in the files shared; mark others 'to confirm'.
- Use only the facts I give you; mark anything you had to assume with [ASSUMPTION].
- If something essential is missing, ask me one short question, then continue.
- No preamble or filler: start with the result.

Confirm you're ready in one line, then wait for me to send my project's file tree, package file and a sentence on what it does.

## Example
Input: CLI in Go that resizes images in bulk; main.go, go.mod, flags: -w -h -q
Output (first lines):
> # imgshrink — resize thousands of images in one command
> ## Quick start: go install …/imgshrink@latest && imgshrink -w 1200 ./photos
> | Flag | Default | Meaning | -q | 82 | JPEG quality |