Create README
Write a README that tells prospective users what the project does, why it is useful, and how to reach a working result.
Workflow
- Inspect the existing README, manifests, public APIs, examples, tests, release metadata, and license as relevant.
- Identify the intended reader, the problem the project solves, its shortest useful workflow, and any adoption-critical limits or tradeoffs.
- Choose only the sections the project needs. A typical order is: project name, direct introduction, key capabilities, installation, a minimal example, advanced workflows or design notes, contributing, and license.
- Write the smallest realistic example first. Use actual commands, package names, APIs, and configuration from the repository. Add specialized examples only when they answer a likely next question.
- Verify changeable claims, commands, links, supported versions, and examples. Run the smallest safe example or relevant check when feasible, and report anything that remains unverified.
House Style
Use the house-style principles below. Consult these examples only when a requested style match needs more context: elithrar/ask-bonk, elithrar/simple-scrypt, elithrar/fuse-on-r2, and especially gorilla/csrf.
- Explain usefulness before setup. Name concrete outcomes and use cases instead of calling the project powerful, robust, or easy.
- Move quickly from context to installation and a working example.
- Introduce examples with what they demonstrate. Progress from the common case to meaningful variants.
- Put security warnings, operational caveats, and tradeoffs beside the example or claim they qualify.
- Use design notes when they help readers trust an important implementation choice.
- Keep the structure proportional to the project. A demo may need only context, tradeoffs, deployment, and links. A mature library may need compatibility, several examples, and design rationale.
- Use concise, direct American English with a conversational technical tone. Keep mild personality when it is natural.
- Preserve the author's terminology and voice. Avoid marketing language, filler, repetition, and sections added only by convention.
Never invent features, commands, support, performance, or maturity. If the project's purpose or audience cannot be established from available evidence, ask one focused question.
For an audit-only request, report prioritized findings without editing. For a create, rewrite, or fix request, update the README and preserve unrelated files.
1---2name: create-readme3description: Write or improve concise, reader-focused README.md files for open source projects. Use for new READMEs, README rewrites, installation and usage examples, or README reviews. Do not use for API references, tutorials, changelogs, contributing guides, or unrelated prose editing.4---56# Create README78Write a README that tells prospective users what the project does, why it is useful, and how to reach a working result.910## Workflow11121. Inspect the existing README, manifests, public APIs, examples, tests, release metadata, and license as relevant.132. Identify the intended reader, the problem the project solves, its shortest useful workflow, and any adoption-critical limits or tradeoffs.143. Choose only the sections the project needs. A typical order is: project name, direct introduction, key capabilities, installation, a minimal example, advanced workflows or design notes, contributing, and license.154. Write the smallest realistic example first. Use actual commands, package names, APIs, and configuration from the repository. Add specialized examples only when they answer a likely next question.165. Verify changeable claims, commands, links, supported versions, and examples. Run the smallest safe example or relevant check when feasible, and report anything that remains unverified.1718## House Style1920Use the house-style principles below. Consult these examples only when a requested style match needs more context: [elithrar/ask-bonk](https://github.com/elithrar/ask-bonk), [elithrar/simple-scrypt](https://github.com/elithrar/simple-scrypt), [elithrar/fuse-on-r2](https://github.com/elithrar/fuse-on-r2), and especially [gorilla/csrf](https://github.com/gorilla/csrf).2122- Explain usefulness before setup. Name concrete outcomes and use cases instead of calling the project powerful, robust, or easy.23- Move quickly from context to installation and a working example.24- Introduce examples with what they demonstrate. Progress from the common case to meaningful variants.25- Put security warnings, operational caveats, and tradeoffs beside the example or claim they qualify.26- Use design notes when they help readers trust an important implementation choice.27- Keep the structure proportional to the project. A demo may need only context, tradeoffs, deployment, and links. A mature library may need compatibility, several examples, and design rationale.28- Use concise, direct American English with a conversational technical tone. Keep mild personality when it is natural.29- Preserve the author's terminology and voice. Avoid marketing language, filler, repetition, and sections added only by convention.3031Never invent features, commands, support, performance, or maturity. If the project's purpose or audience cannot be established from available evidence, ask one focused question.3233For an audit-only request, report prioritized findings without editing. For a create, rewrite, or fix request, update the README and preserve unrelated files.
elithrar