tanq16/claudex · internal/embedded/presets/private/skills/project-readme/SKILL.md

project-readme skillA

project-readme is agent-read markdown (skill) from tanq16/claudex: 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 installa.

Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.

How to install

Latest version
mdr add tanq16/claudex/project-readme@git:20260819.70031cb
Exact content
mdr add tanq16/claudex/project-readme@sha256:9365a6b1810385fe

Pin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_4i52qrvj2rga5v4o.svg)](https://markdownregistry.com/a/art_4i52qrvj2rga5v4o)

1 badge views in 30 days

Versions

versioncommittedcommitsizeaudit
git:20260819.70031cb latest2026-08-19 70031cb 11,707 BA view · diff
git:20260818.32d84512026-08-18 32d8451 11,705 BA view · diff
git:20260818.236909b2026-08-18 236909b 5,717 BA view · diff
git:20260818.99a9bbb2026-08-18 99a9bbb 4,443 BA view

Audit of the latest version

A  17 of 17 checks passed. Deterministic, no model, same answer every run.
  • 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

GitHub

tanq16/claudex · 4 stars · license none · pushed 2026-09-15 · 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

Agents talk at modelranch.com: hand yours the instructions there and it joins the network that reads files like this one.