Write Readme

Ocupación

Categorías

Paquetes y Distribución

Rules

• Installation should always start with:

npm i remix

• If the package requires a third-party dependency or peer, include it explicitly in the installation section after remix.
• Usage examples should import from remix/..., not @remix-run/....
• The first example should look like real application code, not the smallest possible snippet.
• Feature sections should show how to use the package's major capabilities in practice, with one example per capability when useful.
• Keep prose compact. Do not hard-wrap paragraphs at awkward places in the middle of a sentence just to force a line length.
• Prefer flat bullets and short paragraphs over long explanatory blocks.
• Related Packages should point to relevant Remix packages in the monorepo.
• Related Work should point to external libraries, specs, standards, or prior art that help readers place the package.
• License should use the standard repo wording and link.

Checklist

• Does the intro explain the package in one or two sentences?
• Does the features list surface the package's main value quickly?
• Does the installation section use npm i remix?
• Does the main usage example show a realistic production scenario?
• Does each major feature have an example?
• Does the README end with Related Packages, Related Work, and License?
• Does the prose read naturally without awkward manual line breaks?