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
- Read the package API and at least one or two sibling package READMEs before drafting.
- Document the package as it exists today, not the package you wish existed.
- Start with a realistic production usage example as soon as the installation section is done.
- Cover each major feature with a concrete example.
- 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:
# short package-name(i.e.fetch-routerinstead of@remix-run/fetch-router)- Intro: one or two sentences explaining what the package does and why it exists
## Features: a flat bullet list of the main highlights## Installation## Usage: a production-like example that shows the package in context- One section per major feature, each with focused examples
## Related Packages- `## Related Wor…