readme-writing SKILL.md skillA
readme-writing from metraton/gaia is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add metraton/gaia/readme-writing@git:20260925.3549fb0Pins git:20260925.3549fb0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- metraton/gaia
- Path
skills/readme-writing/SKILL.md- Versions recorded
- 6
- Latest version
- git:20260925.3549fb0, committed Sep 25, 2026
- First version recorded
- Aug 12, 2026
- Size
- 15,518 bytes
- Repository stars
- 4
- License
- MIT
Use when writing, rewriting, cleaning up, or updating a README -- the root README of a repository, the README of a folder that holds one kind of thing (modules, migrations, components, services, scripts, environments, workloads; Gaia's own agents/, skills/ and hooks/ are one instance of that same shape), or the README shipped inside a template or scaffold handed to someone else. Triggers -- "escribe el README", "actualiza el README", "limpia el README…
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# README Writing A README is the mental model someone needs before they touch or adopt the thing it describes. One that only lists files is worse than none: it leaves the reader believing they understand something they do not, and they act on that belief. Three things hold for every README, whatever it documents, and are stated here once rather than repeated per case: - **Every tree is annotated.** One line per entry, giving the reason that entry exists. A bare tree adds nothing over `ls`. - **Every link is relative.** An absolute link points at one host, one account, one branch; it breaks in a clone, in a fork, and on every branch it was not written on. - **Every flow is plain text** -- numbered steps and simple `->` arrows in a code block. Never mermaid, never any format that must be rendered to be read. A rendered diagram can only be verified by looking at it rendered, which needs a tool that may not be installed; one shipped recently that nobody could validate for exactly that reason. Plain text reads identically on the web, in a terminal, and in a diff, so what is in the file is what the reader sees. …
Read the whole file at its exact version.
How to install
mdr add metraton/gaia/readme-writing@sha256:b0e4339886984b26The line at the top of this page pins the label git:20260925.3549fb0, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_5irdbnb7nuq245wj)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 6 versions of this file, between Aug 12, 2026 and Sep 25, 2026, about one every 9 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260925.3549fb0 latest | 2026-09-25 | 3549fb0 | 15,518 B | A | view · diff |
| git:20260814.8461870 | 2026-08-14 | 8461870 | 15,333 B | A | view · diff |
| git:20260813.0596153 | 2026-08-13 | 0596153 | 15,337 B | A | view · diff |
| git:20260812.288bca0 | 2026-08-12 | 288bca0 | 13,431 B | A | view · diff |
| git:20260812.2335c96 | 2026-08-12 | 2335c96 | 9,213 B | A | view · diff |
| git:20260812.560889b | 2026-08-12 | 560889b | 8,770 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (15518 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
metraton/gaia · 4 stars · license MIT · pushed 2026-11-05 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_5irdbnb7nuq245wj GET https://markdownregistry.com/api/v1/resolve?ref=metraton/gaia/readme-writing GET https://markdownregistry.com/api/v1/blob/b0e4339886984b263e2e0ac5993362629a3a1bf8052da03101bfdeff70ce93df
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.