readme-craftlisted
Install: claude install-skill Xipher-Labs/walter-os
# README Craft
The README is the only artifact most readers will ever see. It is the
landing page, the install guide, the trust signal, and the marketing
deck — compressed into a single Markdown file that has to read well on a
phone.
This skill gives Claude an opinion: which sections to include for a
given project type, which upstream tools are worth embedding, and which
anti-patterns to refuse.
## When to use
- The user says "write a README", "improve the README", "review my
README", "make this look professional", "what should the README
contain", or any variant.
- A new project is being scaffolded and a `README.md` does not yet
exist or is the stub generated by `npm init` / `cargo new` /
`create-next-app`.
- A repo is being prepared for OSS publication (often paired with
`oss-readiness`) and the existing README is not adequate for outside
readers.
- A hackathon submission needs a README that doubles as the judging
deliverable.
- A GitHub profile README is being created or refreshed.
## When NOT to use
- The user asks for a landing page on a domain. Use `landing-page-fast`
instead; the README is the in-repo doc, the landing is the
marketing site, and they have different content shapes.
- The user asks for long-form blog content or a launch announcement.
Use `content-writer` instead.
- The user asks for documentation beyond the README (API reference,
architecture doc, runbook). Those go under `docs/`, not in the
README itself.
## Project type →