create-readme
Installation
SKILL.md
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.