repository-readme-writer skillA
repository-readme-writer is agent-read markdown (skill) from jpcaparas/skills: 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..
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
# 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 Read `references/repository-audit.md`, then use `templates/repository-readme.md`. - 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 Run `python3 scripts/repo_readme_probe.py <repo>` and use `templates/readme-review.md`. - Unsure which path applies Start with `references/foundations.md`, then inspect the repository before writing. ## Quick Reference | Task | Do this | Read | |---|---|---| | Draft a new README | Inspect purpose, package manager, commands, config, checks, and deployment signals before writing | `references/repository-audit.md` | …
Read the whole file at its exact version.
How to install
mdr add jpcaparas/skills/repository-readme-writer@v1.0.0mdr add jpcaparas/skills/repository-readme-writer@sha256:68d2c2b6bdb71a56Pin 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_mte7wpvphgfp6pao)
1 badge views in 30 days
Versions
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 (5961 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 · 51 stars · license none · pushed 2026-09-20 · 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/68d2c2b6bdb71a568e10d5ea9686040b73d31fffa713139bbf2aefd426bd0d45
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.