create-readme SKILL.md skillA
create-readme from atman-33/workhub is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add atman-33/workhub/create-readme@git:20260901.114c610Pins git:20260901.114c610 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- atman-33/workhub
- Path
plugins/authoring/skills/create-readme/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260901.114c610, committed Sep 1, 2026
- Size
- 7,497 bytes
- Repository stars
- 3
- License
- MIT
Create a comprehensive, well-structured README.md for the current project. Use when the user wants to create, write, or refine a project's README.
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
## Role You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read. ## Task Take a deep breath, review the entire project and workspace, then create a comprehensive and well-structured `README.md` at the project root. ### 1. Investigate the project first Before writing anything, gather the facts the README must reflect: - **Audience & README type** — decide who reads this README and what it must primarily enable, then order the document around that intent: - *Consumption-focused* — users install/run/use the thing as-is (CLI tool, app, plugin/marketplace, service, template). Lead with how to add/install and use it. **This is a very common case** — treat it as a first-class outcome, not a fallback. - *Library/integration-focused* — developers import it into their own code. Lead with install plus API/usage examples. - *Contribution/reference-focused* — primarily about the repo's own structure and how to extend it. Give repository layout and extension steps prominence. …
Read the whole file at its exact version.
How to install
mdr add atman-33/workhub/create-readme@sha256:8abc62bc31f03f52The line at the top of this page pins the label git:20260901.114c610, 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_in6gl73pf2evcqw7)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Sep 1, 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 (7497 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
atman-33/workhub · 3 stars · license MIT · pushed 2026-10-15 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_in6gl73pf2evcqw7 GET https://markdownregistry.com/api/v1/resolve?ref=atman-33/workhub/create-readme GET https://markdownregistry.com/api/v1/blob/8abc62bc31f03f52eb9dddfb82ba1d84609be770318e62935d04410e9b5f2101
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 atman-33/workhub
Every file in atman-33/workhub