readme-forge SKILL.md skillA

readme-forge from tanmayai23/readme-editor-skill is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add tanmayai23/readme-editor-skill/readme-forge@git:20261102.03ea076

Pins git:20261102.03ea076 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
tanmayai23/readme-editor-skill
Path
readme-forge/SKILL.md
Versions recorded
6
Latest version
git:20261102.03ea076, committed Nov 2, 2026
First version recorded
Oct 12, 2026
Size
13,638 bytes
Repository stars
2
License
MIT

Create, audit and fix README files grounded in the real codebase, so every command, env var and path in them is checked against the code. Covers project READMEs (any language, monorepos), Hugging Face model/dataset/Space cards, PyPI/npm-ready variants and companion docs (CONTRIBUTING, SECURITY, CITATION.cff, etc.). Reads facts from 15 ecosystems, draws Mermaid architecture diagrams from actual imports, verifies every claim in the README against the repo, scores READMEs 0-100 with a linter, and…

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

# readme-forge

Write READMEs that are **true to the code**, **fast to scan**, and **correct for the platform** they render on.

Skill directory: `SKILL_DIR` = the folder containing this file. Scripts are stdlib-only Python 3.8+ (`python` or `python3`).

## Step 0 — Pick the mode

| User wants | Mode | Read first |
|---|---|---|
| README for a code project (new or from scratch) | **A. Project** | `references/project-readme.md` |
| Hugging Face model / dataset / Space | **C. Hugging Face** | `references/huggingface.md` |
| "Improve / review / fix / audit my README", "is it accurate?" | **D. Audit** | `references/quality-rubric.md` |
| Same README for PyPI / npm / HF / GitLab | **E. Port** | `references/platforms.md` |
| CONTRIBUTING, SECURITY, CITATION, CHANGELOG, templates | **F. Companion docs** | `templates/extras/` |
| GitHub profile README, animated banner/header/footer, CTA buttons, "make it look amazing" | **Design** | the **readme-forge-design** skill (see below) |

Modes combine (e.g. A + C for an ML repo that ships to GitHub and HF; A + F for "make this repo open-source ready"). Always also apply `references/writing-style.md`.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add tanmayai23/readme-editor-skill/readme-forge@sha256:fc6675c0938fef40

The line at the top of this page pins the label git:20261102.03ea076, 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.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_2jlwgs2qnfr3ituz.svg)](https://markdownregistry.com/a/art_2jlwgs2qnfr3ituz)

1 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 6 versions of this file, between Oct 12, 2026 and Nov 2, 2026, about one every 4 days.

versioncommittedcommitsizeaudit
git:20261102.03ea076 latest2026-11-02 03ea076 13,638 BA view · diff
git:20261019.d0fc1482026-10-19 d0fc148 11,697 BA view · diff
git:20261015.3faab4a2026-10-15 3faab4a 15,464 BA view · diff
git:20261015.bae87442026-10-15 bae8744 15,000 BA view · diff
git:20261014.39b735d2026-10-14 39b735d 14,770 BA view · diff
git:20261012.c82487b2026-10-12 c82487b 14,763 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (13638 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

GitHub

tanmayai23/readme-editor-skill · 2 stars · license MIT · pushed 2026-11-04 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_2jlwgs2qnfr3ituz
GET https://markdownregistry.com/api/v1/resolve?ref=tanmayai23/readme-editor-skill/readme-forge
GET https://markdownregistry.com/api/v1/blob/fc6675c0938fef4061ed74e7f2a24653bf16bcbfcc5dcc5e514ac833855360bf

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 tanmayai23/readme-editor-skill

readme-forge-design SKILL.md skill
tanmayai23/readme-editor-skill · readme-forge-design/SKILL.md · Optional design layer for readme-forge. Designs whole READMEs as SVG cards from one JSON spec (page kit…
git:20261104.8e87ab3 · audit A · 2 stars

Every file in tanmayai23/readme-editor-skill

Browse by kind, by grade A, or by owner.