create-readme SKILL.md skillA
create-readme from afonsoft/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add afonsoft/skills/create-readme@v1.2.1Pins v1.2.1 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- afonsoft/skills
- Path
skills/create-readme/SKILL.md- Versions recorded
- 11
- Latest version
- v1.2.1, committed Sep 20, 2026
- First version recorded
- Sep 5, 2026
- Size
- 13,611 bytes
- Repository stars
- 14
- License
- MIT
Use when generating or updating a project README.md or CHANGELOG.md.
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
# Create README and CHANGELOG ## Overview Transforms a raw repository into a well-documented project by generating professional `README.md` and `CHANGELOG.md` files based on empirical evidence from the codebase, git history, and configuration files. Every claim in the generated documentation must be traceable to a file, commit, or config in the repository. ## When to Use - When a project lacks a README or CHANGELOG. - When existing documentation is outdated, incomplete, or inconsistent. - Before shipping a new version to ensure the changelog is up to date. - When restructuring a project and the existing documentation no longer reflects the architecture. - When onboarding new contributors and the README doesn't answer "what is this, how do I run it, how do I test it?" - User asks or mentions this skill in English (e.g., "use /create-readme", "run create-readme"). - O usuário pede ou menciona esta skill em português (ex.: "use /create-readme", "execute create-readme"). ## When NOT to Use - **API reference docs** — use OpenAPI/Swagger, TypeDoc, Sphinx, or docfx instead. - **License files** — copy the appropriate license text directly (MIT, Apache-2.0, etc.). …
Read the whole file at its exact version.
How to install
mdr add afonsoft/skills/create-readme@sha256:7a4b375cbf9f15dbThe line at the top of this page pins the label v1.2.1, 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_a4ywk2sjk4i5rgsz)
4 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 11 versions of this file, between Sep 5, 2026 and Sep 20, 2026, about one every day.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.2.1 latest | 2026-09-20 | 1d3ecda | 13,611 B | A | view · diff |
| v1.2.1 | 2026-09-12 | cf88aa9 | 13,556 B | A | view · diff |
| v1.2.0 | 2026-09-12 | f327983 | 13,556 B | A | view · diff |
| v1.1.1 | 2026-09-12 | c18635f | 13,556 B | A | view · diff |
| v1.1.1 | 2026-09-11 | ba4965c | 13,517 B | A | view · diff |
| v1.1.1 | 2026-09-11 | 1f72d60 | 13,871 B | A | view · diff |
| v1.1.0 | 2026-09-10 | 8136228 | 13,871 B | A | view · diff |
| v1.1.0 | 2026-09-09 | 6107e4d | 13,664 B | A | view · diff |
| v1.1.0 | 2026-09-05 | 9fa4cd6 | 11,530 B | A | view · diff |
| v1.1.0 | 2026-09-05 | a9f7a95 | 11,490 B | A | view · diff |
| v1.0.0 | 2026-09-05 | ff32dbe | 4,222 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 (13611 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
afonsoft/skills · 14 stars · license MIT · pushed 2026-10-27 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_a4ywk2sjk4i5rgsz GET https://markdownregistry.com/api/v1/resolve?ref=afonsoft/skills/create-readme GET https://markdownregistry.com/api/v1/blob/7a4b375cbf9f15dba74834e6bc621b54aae055eda0fc61e754c69e1cd220b45b
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.