crafting-readme-files SKILL.md skillB
crafting-readme-files from dicklesworthstone/meta_skill is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add dicklesworthstone/meta_skill/crafting-readme-files@git:20260114.d961bafPins git:20260114.d961baf in mdr.lock. Pin the fingerprint instead.
- Audit grade
- B, 16 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- dicklesworthstone/meta_skill
- Path
skills/crafting-readme-files/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260114.d961baf, committed Jan 14, 2026
- Size
- 13,687 bytes
- Repository stars
- 210
- License
- a license file GitHub does not identify
Craft professional README.md files for GitHub open source projects. Generates hero sections, installation instructions, feature tables, and architecture diagrams. Use when creating or revising a README, documenting a CLI tool, library, or open source project, or when user asks about README structure, badges, or project documentation.
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
# Crafting README.md Files for GitHub > **Core insight:** A README is a sales pitch, onboarding guide, and reference manual compressed into one document. Lead with value, prove with examples, document with precision. ## Why This Matters Most READMEs fail because they: - Bury the value proposition under installation steps - Explain what the tool IS instead of what problem it SOLVES - Lack concrete examples (abstract descriptions don't sell) - Miss the "quick escape hatch" for impatient users (curl one-liner) - Don't show how it compares to alternatives Great READMEs convert scanners into users in under 60 seconds. --- ## THE EXACT PROMPT — README Revision ``` Read the current README.md and dramatically revise it following this structure: 1. Hero section: illustration + badges + one-liner description + curl install 2. TL;DR: "The Problem" + "The Solution" + "Why Use X?" feature table 3. Quick example showing the tool in action (5-10 commands) 4. Design philosophy (3-5 principles with explanations) 5. Comparison table vs alternatives 6. Installation (curl one-liner, package managers, from source) 7. Quick start (numbered steps, copy-paste ready) …
Read the whole file at its exact version.
How to install
mdr add dicklesworthstone/meta_skill/crafting-readme-files@sha256:8039b6806dd3cf8dThe line at the top of this page pins the label git:20260114.d961baf, 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_nnqeftnhvuwxizzg)
1 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Jan 14, 2026.
Audit of the latest version
- fail: No curl or wget piped into a shell (matched: curl | bash)
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (13687 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 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
Starting a new one? Use a template for SKILL.md on mdpantry, which passes every one of these checks and says what to change in it.
Source
dicklesworthstone/meta_skill · 210 stars · license a license file GitHub does not identify · pushed 2026-11-02 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_nnqeftnhvuwxizzg GET https://markdownregistry.com/api/v1/resolve?ref=dicklesworthstone/meta_skill/crafting-readme-files GET https://markdownregistry.com/api/v1/blob/8039b6806dd3cf8df23db2e489633468dbaf01f8d2ed0b0d3bcdfb11b6898839
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.