create-readme SKILL.md skillA
create-readme from tomzx/agents is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add tomzx/agents/create-readme@git:20261007.b35fc4bPins git:20261007.b35fc4b in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- tomzx/agents
- Path
skills/create-readme/SKILL.md- Versions recorded
- 5
- Latest version
- git:20261007.b35fc4b, committed Oct 7, 2026
- First version recorded
- Jun 29, 2026
- Size
- 5,302 bytes
- Repository stars
- 12
- License
- MIT
Generate a README.md for a project using a structured template with badges, feature lists, roadmap, and setup instructions.
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
# Write README Produces a `README.md` for a project using a fixed template with centered header, badges, feature list, roadmap, and setup instructions. Derives content from the codebase, existing configuration files, and any available context. ## Prerequisites - A project directory with source code, a license file, and a package manifest (e.g., `go.mod`, `package.json`, `Cargo.toml`, `pyproject.toml`) - If `$1` is provided, use it as the project directory; otherwise use the current working directory ## Steps 1. Scan the project for metadata: repository name from git remote or directory name, license type, language/runtime version from the package manifest, storage or database dependencies, and platform targets. 2. Determine a one-sentence description of the project from existing docs, the package manifest description, or by reading the main entry point. 3. List features by scanning source directories, CLI commands, exported functions, and any existing documentation. 4. Identify roadmap items from open GitHub issues, TODO comments, or stated goals in docs. 5. Identify out-of-scope items by reading issue discussions, design docs, or the package manifest's stated purpose. …
Read the whole file at its exact version.
How to install
mdr add tomzx/agents/create-readme@sha256:c9dfd54b8f863ea0The line at the top of this page pins the label git:20261007.b35fc4b, 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_wwmi5xexd2wm5hfi)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Jun 29, 2026 and Oct 7, 2026, about one every 25 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261007.b35fc4b latest | 2026-10-07 | b35fc4b | 5,302 B | A | view · diff |
| git:20261005.8154ecd | 2026-10-05 | 8154ecd | 5,299 B | A | view · diff |
| git:20261001.eb888e9 | 2026-10-01 | eb888e9 | 5,411 B | A | view · diff |
| git:20260827.0e11dc9 | 2026-08-27 | 0e11dc9 | 5,277 B | A | view · diff |
| git:20260629.99ff6a9 | 2026-06-29 | 99ff6a9 | 5,069 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 (5302 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
tomzx/agents · 12 stars · license MIT · pushed 2026-10-21 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_wwmi5xexd2wm5hfi GET https://markdownregistry.com/api/v1/resolve?ref=tomzx/agents/create-readme GET https://markdownregistry.com/api/v1/blob/c9dfd54b8f863ea00f2bcaff6ccf46b5cac66bded3b44e35a257c0eff5497f0d
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.