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:20261015.1b4d9dcPins git:20261015.1b4d9dc in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- mickpletcher/ai-skills
- Path
master-skills/github-readme/SKILL.md- Versions recorded
- 1
- Latest version
- git:20261015.1b4d9dc, committed Oct 15, 2026
- Size
- 3,675 bytes
- Repository stars
- 20
- License
- MIT
Write or repair an accurate, repository-specific README based on verified project files and requirements.
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
# Repository README Writer ## Purpose Create or update README documentation that accurately describes a repository, its installation, configuration, use, testing, and limitations. Prefer verified evidence over plausible-looking instructions. ## Triggers Use when asked to write, rewrite, repair, or document a repository README. Recognize the shortcuts `readme` and `gr` followed by repository details. ## Do not use - For designing a new repository from scratch: use a repository architecture workflow. - For implementing code, reviewing a pull request, or auditing unrelated documentation. - When the user has provided too little information to identify the repository: ask for a repository link, path, or description. ## Inputs and evidence Obtain the repository name, purpose, audience, language, files, entry points, dependencies, configuration, license, and existing README when available. Prefer inspected repository files over an old README, and an old README over unsupported guesses. If repository access is unavailable, label any unverifiable commands, paths, and claims explicitly. ## Workflow …
Read the whole file at its exact version.
How to install
mdr add mickpletcher/ai-skills/github-readme@sha256:b17ff215deea7a59The line at the top of this page pins the label git:20261015.1b4d9dc, 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_scncnqr2iipptnt2)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Oct 15, 2026.
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 (3675 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_scncnqr2iipptnt2 GET https://markdownregistry.com/api/v1/resolve?ref=mickpletcher/ai-skills/github-readme GET https://markdownregistry.com/api/v1/blob/b17ff215deea7a5972bf3337685a839c4fa796d50920320a2e9a335f64f442d9
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