repository-readme-writer SKILL.md skillA
repository-readme-writer from jpcaparas/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add jpcaparas/skills/repository-readme-writer@v1.0.0Pins v1.0.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- jpcaparas/skills
- Path
skills/writing/repository-readme-writer/SKILL.md- Versions recorded
- 2
- Latest version
- v1.0.0, committed Sep 25, 2026
- First version recorded
- Sep 12, 2026
- Size
- 7,136 bytes
- Repository stars
- 56
- License
- none declared
Create or improve concise, useful, agent-safe repository READMEs. Use for new README drafts, rewrites, quickstarts, local setup, getting started, contributor docs, or README reviews. Do NOT use for API reference, full product docs, changelogs, or landing pages.
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 Create or improve repository READMEs that help humans and agents understand the project quickly without overfitting to fragile implementation details. ## Decision Tree What kind of README work is this? - Creating a new README from a repository Inspect relevant repository evidence; consult `references/repository-audit.md` and adapt `templates/repository-readme.md` when useful. - Improving an existing README Read `references/rewrite-patterns.md`, then preserve useful sections and remove stale or overly specific material. - Fixing only the setup path Read `references/quickstart-design.md` and make the quickstart the shortest verified path from clone to useful local feedback. - Reviewing README quality without editing yet Review the requested scope against repository evidence. The probe and `templates/readme-review.md` are optional aids for broader reviews, not prerequisites for a wording or link review. - Unsure which path applies Start with `references/foundations.md`, then inspect the repository before writing. ## Quick Reference | Task | Do this | Read | |---|---|---| …
Read the whole file at its exact version.
How to install
mdr add jpcaparas/skills/repository-readme-writer@sha256:6afeaf361a42e30bThe line at the top of this page pins the label v1.0.0, 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_mte7wpvphgfp6pao)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Sep 12, 2026 and Sep 25, 2026, about one every 13 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.0 latest | 2026-09-25 | 692d684 | 7,136 B | A | view · diff |
| v1.0.0 | 2026-09-12 | 938fe03 | 5,961 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 (7136 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
jpcaparas/skills · 56 stars · license none declared · pushed 2026-11-03 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_mte7wpvphgfp6pao GET https://markdownregistry.com/api/v1/resolve?ref=jpcaparas/skills/repository-readme-writer GET https://markdownregistry.com/api/v1/blob/6afeaf361a42e30b819f7d58be8e990dcb63bb3ffbec33d50de31a83816a85ba
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.