write-readme

Write Readme

Overview

Draft README files as concise package documentation for real users, not as marketing copy or API dumps. Mirror the structure used across this repository, keep examples production-oriented, and avoid awkward manual line breaks in prose.

Workflow

1. Read the package API and at least one or two sibling package READMEs before drafting.
2. Document the package as it exists today, not the package you wish existed.
3. Start with a realistic production usage example as soon as the installation section is done.
4. Cover each major feature with a concrete example.
5. Finish with internal ecosystem links, external related work, and license info.

Structure

Use this section order unless there is a strong package-specific reason not to:

1. # short package-name (i.e. fetch-router instead of @remix-run/fetch-router)
2. Intro: one or two sentences explaining what the package does and why it exists
3. ## Features: a flat bullet list of the main highlights
4. ## Installation
5. ## Usage: a production-like example that shows the package in context
6. One section per major feature, each with focused examples
7. ## Related Packages