← ClaudeAtlas

oss-readmelisted

Write or improve a README.md for an open source project. Use this for any request to create, rewrite, review, or polish a README, project description, or getting-started docs for a library, framework, or tool, or to make an open source project more attractive to users. Covers structure and section order. For the sentences themselves, oss-writing owns style. Do NOT use for internal or private repo docs, API reference generation, or CHANGELOG and CONTRIBUTING files.
svyatov/oss-kit · ★ 1 · AI & Automation · score 68
Install: claude install-skill svyatov/oss-kit
# README structure Apply the structure below when creating or improving a README. It follows Evil Martians' approach to promoting open source projects such as PostCSS, Nano ID, imgproxy, and AnyCable: put the reason to keep reading at the top, and the details below. This skill owns section order and what each section must contain. It does not own how a sentence reads. Once the sections below are in place, apply oss-writing to the prose inside them. Never invent facts. If the repository does not contain a piece of data you need, such as a benchmark, a file size, a real differentiator from alternatives, or a supported platform list, or you are not sure a number is accurate, ask for it instead of guessing. A README with a fabricated number is worse than one with no number at all. ## Section order ### 1. Title A `#` heading naming the project. Nothing else goes in the heading text. ### 2. Opening sentence Immediately below the title, one sentence stating what the project is and who it is for. Nothing may come before it: no badge row, no table of contents, no other heading. Say what the project does in plain terms, without jargon a newcomer would have to look up. If you do not know who the project is for or what makes it different from the alternative a reader already knows, ask rather than guessing at a differentiator. Keep it short. The standard-readme spec caps a description at 120 characters, which is a useful ceiling rather than a limit this skill enforces. A two-se