readme
/readme
Pisze lub przepisuje README repozytorium tak, by pierwszy ekran pokazywał projekt, a każde twierdzenie dało się sprawdzić.
- Autor
- Jeff-Kazzee ↗
- Repozytorium
- github-skills ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 08.11.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 7
- Skrypty
- 5
- Komentarze HTML
- 1
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 08.11.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
- 5 skryptów w paczce. Przejrzyj je przed instalacją, bo Claude może je uruchomić.
- SKILL.md zawiera komentarze HTML (1). Nie widać ich w podglądzie Markdown, a model je czyta.
Skrypty: scripts/entry.test.mjs, scripts/image-check.mjs, scripts/image-check.test.mjs, scripts/readme-check.mjs, scripts/readme-check.test.mjs
Co robi i kiedy
Pisze lub przepisuje README repozytorium tak, by pierwszy ekran pokazywał projekt, a każde twierdzenie dało się sprawdzić.
Oryginalny opis (EN)
Writes or rewrites a repository README that shows the project on its first screen and proves every claim. Use when a repo needs a README, when one is stale, or before a repo goes public. Not for other docs, use `technical-writing`. Not for website copy, use `storybrand-design`.
Jak działa
- 1. Gather the facts
- 2. Capture the visual
- 3. Write from the template
- 4. Check it
- 5. Publish
Podgląd SKILL.md
---
name: readme
description: Writes or rewrites a repository README that shows the project on its first screen and proves every claim. Use when a repo needs a README, when one is stale, or before a repo goes public. Not for other docs, use `technical-writing`. Not for website copy, use `storybrand-design`.
---
# README
A README takes a stranger from "what is this?" to "I'm using it". Every claim in it
holds up when someone checks. A number, a badge or a link that fails makes the
repo look worse than having none, so each one earns its place.
## 1. Gather the facts
Read the repo and run it. Write down what it does, who it is for, how it starts, and
its license. Each fact comes from a file, a command output or a page you opened in this
session.
Done when every planned claim has a source you saw. A fact you could not confirm stays
out, or stays as `[JEFF]` for the owner to fill.
## 2. Capture the visual
Pick the strongest one the project supports, from the real product:
| Project | Visual |
|---|---|
| Has a UI | A screenshot or short GIF of a real flow |
| CLI | A terminal recording, or the real output in a fenced block |
| Library | A short code sample and its real output |
Commit it under `docs/`. Open it and look at it. Crop or redo anything that shows a
token, an email address or customer data.
Done when the visual is in the repo and you have looked at it.
## 3. Write from the template
Copy [references/template.md](references/template.md) and fill every field. Its layout is
the one the check reads. Keep to these limits:
| Part | Limit |
|---|---|
| Name and line | A name and one line of at most 10 words |
| Badges | 3 to 5, each showing a real signal: CI, version, license |
| First screen | The name, the line, the badges and the visual, all in the first 40 lines |
| Features | 4 to 7 bullets, each a benefit a user gets. Plain bullets |
| Quick start | At most 5 commands, in one fenced `sh` block, that end at something working |
| Examples | 2 or 3, going from simple to real |
| Documentation | A link, or a pointer to the section that serves as the docs |
| Contributing | A link to `CONTRIBUTING.md`, or the steps |
| License | The name and a link to `LICENSE` |
Keep the README to one job. Architecture goes in `ARCHITECTURE.md`, with one link from
the README. API references and policies go in their own files too.
Write for someone who has never seen the project. Follow the Writing law. A number
about stars, users, downloads, speed or adoption carries its source on the same line, as
`<!-- source: <url> -->`. A library's API table belongs in the README only when it is
short.
Run `unslop` on the prose. Done when no `{{field}}` is left.
## 4. Check it
Run from the repo root, in the repo's checkout on `linveo-16gb` when it has one:
```sh
node <this skill's folder>/scripts/readme-check.mjs README.md --online --clone <repo url or path>
```
The check fails on any of these:
- A missing, empty or out-of-order section, or a limit in the table above.
- A number with no source, or a claim such as "trusted by" that the repo cannot back.
- An emoji bullet, an em dash, a semicolon in prose, or a marketing adjective.
- With `--online`, a dead link, a missing or broken image, a broken anchor, or a badge that
reports an error. PNG pixel data is decoded. Other formats get a structure check, so
look at the visual yourself.
- With `--clone`, a quick start command that fails on a fresh clone.
`--clone` runs the quick start's commands on the machine you run it on. For a repo Jeff
owns, run it on `linveo-16gb`. For anything else, run it inside a Daytona sandbox. If you
have neither, leave `--clone` off and say so in your report. A URL clones the default
branch, so pass the path of a checkout to test a branch before it merges.
`--online` treats a local link outside the folder that holds `.git` as broken. For a tree
with no `.git` folder, such as an archive export, pass `--root <dir>` to name the root.
Done when the command exits 0 on the commit you will publish. A failure means the README
or the project is wrong. Fix whichever one lied.
## 5. Publish
Open the change as a normal PR with the `pr-template` skill. Put the check's output in
Proof. For a public repo, Jeff approves the text before it goes out, because it is
published in his name.
Pliki w paczce (7)
- SKILL.md 4 KB
- references/template.md 2 KB
- scripts/entry.test.mjs 1 KB
- scripts/image-check.mjs 4 KB
- scripts/image-check.test.mjs 4 KB
- scripts/readme-check.mjs 19 KB
- scripts/readme-check.test.mjs 27 KB
Wersje
| Repozytorium | Wynik | Licencja |
|---|---|---|
| Ta strona · Jeff-Kazzee/github-skills | 100 | MIT |
| tamaplus/josjis-code | 100 | MIT |
| sorah/config | 100 | MIT |
| Dhananjay-JSR/skills | 100 | MIT |
| jasonm4130/claude-skills | 100 | MIT |
| samplexbro/agentsmesh | 100 | MIT |
| tushaarmehtaa/tushar-skills | 100 | MIT |
| samplexbro/agentsmesh | 100 | MIT |
| rootcastleco/rei-skills | 95 | MIT |
Migawka bazy z 13.11.2026 · wersja paczki 69596ef36ffc (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 90writing-readmes
Pisze, przepisuje lub przegląda README repozytorium, tak by pierwszy ekran mówił, czym jest projekt i dla kogo. - 100readme-optimization
Audytuje i przepisuje README repozytorium, sprawdzając każde twierdzenie i instalację względem kodu, tak by nowa osoba uruchomiła projekt w minutę. - 100repo
Aktualizuje dokumentację repozytorium, czyli README, docs i CLAUDE.md, na podstawie zmian z sesji. - 100rc-readme
Pisze lub odświeża README projektu na podstawie dowodów z bazy kodu. - 95github-readme
Pisze lub przerabia minimalne techniczne README dla projektu lub repozytorium GitHub, opierając się wyłącznie na sprawdzonych faktach. - 100refresh-repo-docs
Audytuje dokumentację repozytorium (README, docs, CHANGELOG, CONTRIBUTING, przykłady) względem kodu, poprawia nieaktualne zapisy i weryfikuje każde twierdzenie.