project-readme SKILL.md skillA
project-readme from tanq16/claudex is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add tanq16/claudex/project-readme@git:20260819.70031cbPins git:20260819.70031cb in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- tanq16/claudex
- Path
internal/embedded/presets/private/skills/project-readme/SKILL.md- Versions recorded
- 4
- Latest version
- git:20260819.70031cb, committed Aug 19, 2026
- First version recorded
- Aug 18, 2026
- Size
- 11,707 bytes
- Repository stars
- 3
- License
- none declared
README structure for every project type: the frozen header block, the opener, and the rules that decide which sections a project earns and how long each one gets. Covers install paths including the self-hosted Docker run and compose blocks, collapsed tabular screenshots, and the test for when a section becomes its own file under docs/. Use when creating a README, restructuring one, deciding whether something belongs in the README at all, adding badges or navigation links, or documenting…
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
# Project README **A frozen header, then a fixed spine of sections that each project earns rather than inherits.** A README sells the project, gets a reader to first use, and sends anything that needs real depth to its own file. Length follows what has to be explained, so two projects of similar size can differ by 3x and both be right. Match a project's existing README style when it already has one. Restructuring a working README to match a template is churn the reader has to re-read to discover nothing changed. ## When to Use Writing a README, restructuring one, or deciding whether some piece of documentation belongs in the README, in a `docs/` file, or nowhere. ## The reader The reader found this project by searching for what it is, so they already hold the concept and need the specifics. A web terminal needs no explanation of web terminals. Explaining what the reader came in knowing is the most common way a README doubles in length without gaining a fact. ## The spine Seven slots in this order, and this is a ceiling rather than a checklist: | Section | Holds | Present when | |---|---|---| | Header block | logo, name, badges, 3-5 nav links | always | …
Read the whole file at its exact version.
How to install
mdr add tanq16/claudex/project-readme@sha256:9365a6b1810385feThe line at the top of this page pins the label git:20260819.70031cb, 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_4i52qrvj2rga5v4o)
7 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 4 versions of this file, between Aug 18, 2026 and Aug 19, 2026, more than one a day.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260819.70031cb latest | 2026-08-19 | 70031cb | 11,707 B | A | view · diff |
| git:20260818.32d8451 | 2026-08-18 | 32d8451 | 11,705 B | A | view · diff |
| git:20260818.236909b | 2026-08-18 | 236909b | 5,717 B | A | view · diff |
| git:20260818.99a9bbb | 2026-08-18 | 99a9bbb | 4,443 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 (11707 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
tanq16/claudex · 3 stars · license none declared · pushed 2026-10-12 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_4i52qrvj2rga5v4o GET https://markdownregistry.com/api/v1/resolve?ref=tanq16/claudex/project-readme GET https://markdownregistry.com/api/v1/blob/9365a6b1810385feb2b8d89ec3faffe9e1210f2a92cd76ed902074fcbe644dba
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.