github-readme SKILL.md skillA
github-readme from mickpletcher/ai-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add mickpletcher/ai-skills/github-readme@git:20260610.d1e991fPins git:20260610.d1e991f in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- mickpletcher/ai-skills
- Path
claude/skills/github-readme/SKILL.md- Versions recorded
- 5
- Latest version
- git:20260610.d1e991f, committed Jun 10, 2026
- First version recorded
- Apr 24, 2026
- Size
- 11,085 bytes
- Repository stars
- 20
- License
- MIT
Generate polished GitHub README.md files for Mick's repositories in his established voice and structure. Always trigger immediately when the user's message starts with "readme" or "gr". Also trigger on "write a readme", "generate readme", "readme for this repo", "document this repo", or any request to create or rewrite a GitHub README. Produces a complete, repo-specific README with the right sections for the project instead of a generic template.
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
# GitHub README Skill ## Intent Create or improve README files that accurately explain what a repo does, how to run it, and how a practical user should start. ## Do Not Use When - Do not use when the user wants code implementation, PR review, repo architecture, or docs that are not tied to live repo behavior. - Required context is missing and cannot be reasonably inferred. - A more specific skill in this repo is a better match. ## Constraints - Do not fabricate missing facts, measurements, dates, sources, or user context. - Keep output aligned with Mick's direct, practical communication style unless the skill says otherwise. - Preserve safety, legal, medical, financial, and operational boundaries stated in this file. - Prefer concise, usable output over broad explanation. ## Validation Checklist - [ ] The output matches the skill's intended task and platform. - [ ] Required inputs, assumptions, and uncertainty are explicit. - [ ] Safety, scope, and source limits are respected. - [ ] The response follows the requested format or the skill's default output format. - [ ] The result is practical enough to use without another cleanup pass. …
Read the whole file at its exact version.
How to install
mdr add mickpletcher/ai-skills/github-readme@sha256:a872b64327a072deThe line at the top of this page pins the label git:20260610.d1e991f, 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_felo5grj7jotzfsd)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Apr 24, 2026 and Jun 10, 2026, about one every 12 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260610.d1e991f latest | 2026-06-10 | d1e991f | 11,085 B | A | view · diff |
| git:20260609.a0be1e4 | 2026-06-09 | a0be1e4 | 9,170 B | A | view · diff |
| git:20260522.736a01e | 2026-05-22 | 736a01e | 8,914 B | A | view · diff |
| git:20260514.3080b38 | 2026-05-14 | 3080b38 | 7,776 B | A | view · diff |
| git:20260424.ae60684 | 2026-04-24 | ae60684 | 7,077 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 (11085 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
mickpletcher/ai-skills · 20 stars · license MIT · pushed 2026-10-20 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_felo5grj7jotzfsd GET https://markdownregistry.com/api/v1/resolve?ref=mickpletcher/ai-skills/github-readme GET https://markdownregistry.com/api/v1/blob/a872b64327a072dedb06e7ff512436c57becdbc186153d54275e137676d0a214
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.
More from mickpletcher/ai-skills
Every file in mickpletcher/ai-skills