github-readme skillA
github-readme is agent-read markdown (skill) from avalonreset/legends-github: Write or improve repository documentation from actual capabilities, verified setup and examples, useful comparisons, and audience needs. Optional artwork and research never block the README..
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.
What the file says
# GitHub README Make the project understandable and usable for its intended audience. Preserve accurate existing material, upstream credits, and the owner's voice. ## Runtime and scope Resolve **GITHUB_HOME** from this skill directory: `../../github` in source, `../github` when installed. Verify `scripts/run_headless.py` exists and read `GITHUB_HOME/references/portable-workflows.md`. Resolve **TARGET** separately. ```text python "<GITHUB_HOME>/scripts/run_headless.py" readme --help python "<GITHUB_HOME>/scripts/run_headless.py" readme --path "<TARGET>" python "<GITHUB_HOME>/scripts/run_headless.py" readme --path "<TARGET>" --write ``` Default mode creates `readme-data.json`, `README-REPORT.md`, `README-PREVIEW.md`, and `README-SUMMARY.json` at returned artifact paths. Inspect the preview before `--write`, which can replace curated content. A targeted edit is often better than using an entire generated template. A generated score is not validation. ## Gather before drafting - Read the existing README in its actual format, including RST or other supported formats. Do not convert it merely for consistency with a template. …
Read the whole file at its exact version.
How to install
mdr add avalonreset/legends-github/github-readme@git:20260921.35da7eemdr add avalonreset/legends-github/github-readme@sha256:e416d55031090025Pin 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.
[](https://markdownregistry.com/a/art_6ttahll3gnstf5yz)
1 badge views in 30 days
Versions
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260921.35da7ee latest | 2026-09-21 | 35da7ee | 7,758 B | A | view · diff |
| git:20260921.029882f | 2026-09-21 | 029882f | 24,556 B | A | view · diff |
| git:20260921.a2e8de7 | 2026-09-21 | a2e8de7 | 7,355 B | A | view · diff |
| git:20260509.b2d3e98 | 2026-05-09 | b2d3e98 | 29,064 B | A | view · diff |
| git:20260318.70b9ec6 | 2026-03-18 | 70b9ec6 | 28,859 B | A | view · diff |
| git:20260316.94ab1d3 | 2026-03-16 | 94ab1d3 | 28,366 B | A | view · diff |
| git:20260316.477759b | 2026-03-16 | 477759b | 27,365 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 (7758 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
avalonreset/legends-github · 4 stars · license MIT · pushed 2026-09-24 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_6ttahll3gnstf5yz GET https://markdownregistry.com/api/v1/resolve?ref=avalonreset/legends-github/github-readme GET https://markdownregistry.com/api/v1/blob/e416d55031090025a4491360bf659b3ec5c3e01accb48b4b9d37019f067a99ba
Your agent 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.
More from avalonreset/legends-github
Every file in avalonreset/legends-github