crafting-effective-readmes SKILL.md skillA

The newest version of a file that held these bytes earlier

crafting-effective-readmes in dannykkh/skill-olympus is at git:20260615.8873c38 (Jun 15, 2026), graded A.

mdr add dannykkh/skill-olympus/crafting-effective-readmes@git:20260615.8873c38

This copy is 1 version behind it. See what changed · install this older copy instead

This line moves to the next version by itself within about an hour of that file saving one. A copy already installed stays as it is until you update it.

crafting-effective-readmes from furuyan1234/nano-banana-pro is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
furuyan1234/nano-banana-pro
Path
.agents/skills/crafting-effective-readmes/SKILL.md
Versions recorded
1
Latest version
git:20260227.0564cc7, committed Feb 27, 2026
Size
2,676 bytes
Repository stars
20
License
MIT

Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.

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 Effective READMEs

## Overview

READMEs answer questions your audience will have. Different audiences need different information - a contributor to an OSS project needs different context than future-you opening a config folder.

**Always ask:** Who will read this, and what do they need to know?

## Process

### Step 1: Identify the Task

**Ask:** "What README task are you working on?"

| Task | When |
|------|------|
| **Creating** | New project, no README yet |
| **Adding** | Need to document something new |
| **Updating** | Capabilities changed, content is stale |
| **Reviewing** | Checking if README is still accurate |

### Step 2: Task-Specific Questions

**Creating initial README:**
1. What type of project? (see Project Types below)
2. What problem does this solve in one sentence?
3. What's the quickest path to "it works"?
4. Anything notable to highlight?

**Adding a section:**
1. What needs documenting?
2. Where should it go in the existing structure?
3. Who needs this info most?

**Updating existing content:**
1. What changed?
2. Read current README, identify stale sections
3. Propose specific edits

**Reviewing/refreshing:**
1. Read current README
…

Read the whole file at its exact version.

How to install

This older copy, pinned
mdr add furuyan1234/nano-banana-pro/crafting-effective-readmes@git:20260227.0564cc7

Pins git:20260227.0564cc7 in mdr.lock, 1 version behind the newest at the top of this page.

No tool to install first
claude plugin marketplace add https://markdownregistry.com/mp/a/art_mjmfqg3zhx2aydk2/638b271fdc148249ed8896dbdcf15f9067a8d64ba7d2d82ec3e86f8d82831b51.json

Then /plugin install crafting-effective-readmes@markdownregistry-mjmfqg3zhx2aydk2 in Claude Code. It installs git:20260227.0564cc7, the one graded A here, pinned to the commit it was graded at, and leaves it there.

The exact contents, by fingerprint
mdr add furuyan1234/nano-banana-pro/crafting-effective-readmes@sha256:638b271fdc148249

The older copy line above pins the label git:20260227.0564cc7, 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_mjmfqg3zhx2aydk2.svg)](https://markdownregistry.com/a/art_mjmfqg3zhx2aydk2)

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

Ask from your agent
claude mcp add --transport http markdownregistry https://markdownregistry.com/mcp/registry

Then ask it: get me the newest dannykkh/skill-olympus/crafting-effective-readmes, and what changed since 638b271? It reads every saved version here, no key and no account. Any agent that speaks MCP can add it.

Got a copy of crafting-effective-readmes from somewhere else? Ask it: where did my crafting-effective-readmes come from, and what was changed? It names the public original, the version yours is closest to and every changed line. The text is not kept.

Versions

The registry has recorded 1 version of this file, committed on Feb 27, 2026.

Watch this file (sign in, one email per new version)

versioncommittedcommitsizeaudit
git:20260227.0564cc7 latest2026-02-27 0564cc7 2,676 BA view

Copies

The newest version, then this copy

Newest: git:20260615.8873c38 of crafting-effective-readmes in dannykkh/skill-olympus (skills/crafting-effective-readmes/SKILL.md), graded A.

This copy: byte for byte that file's version git:20260131.9f78a80, which it committed on Jan 31, 2026, before this repository did; graded A, 1 version behind.

See what changed since these bytes · ask your agent

Matched on the exact bytes and the commit dates, nothing else. It does not say who wrote the file or where this repository got it.

Keep it current by itself, install once

Committed this skill to a repository? Install the markdownregistry skill updates app on it, or on all of them. When the registry saves a newer version, a pull request brings your copy to it within minutes, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

Install on GitHub

It asks to read and write contents and pull requests, and to read metadata. No workflow file, no Actions setting, nothing runs on your runners. Uninstall it and everything the registry kept about your repository is deleted.

Keep it current by itself

Committed this skill to a repository? Add one workflow file, and when a newer version is saved, a pull request brings your copy to it, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

mkdir -p .github/workflows && curl -fsSL https://markdownregistry.com/ci/skill-updates.yml -o .github/workflows/skill-updates.yml

It runs daily on GitHub Actions, no key and no account. Read the workflow before you add it.

Check a whole project

From the root of your project, one line hashes each installed skill's SKILL.md, your AGENTS.md and your CLAUDE.md, and asks the registry once. Only the fingerprints and paths are sent.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --data-binary @- https://markdownregistry.com/api/v1/check-copies

In CI, add --fail-with-body: the answer is 409 when any file is behind, so the step fails and still prints which files.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --fail-with-body --data-binary @- https://markdownregistry.com/api/v1/check-copies

No sha256sum on your machine? shasum -a 256 prints the same lines.

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 (2676 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

furuyan1234/nano-banana-pro · 20 stars · license MIT · pushed 2026-11-19 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_mjmfqg3zhx2aydk2
GET https://markdownregistry.com/api/v1/resolve?ref=furuyan1234/nano-banana-pro/crafting-effective-readmes
GET https://markdownregistry.com/api/v1/blob/638b271fdc148249ed8896dbdcf15f9067a8d64ba7d2d82ec3e86f8d82831b51

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 furuyan1234/nano-banana-pro

agent-md-refactor SKILL.md skill
furuyan1234/nano-banana-pro · .agents/skills/agent-md-refactor/SKILL.md · Refactor bloated AGENTS.md, CLAUDE.md, or similar agent instruction files to follow progressive disclosure principles…
git:20260227.0564cc7 · audit A · 20 stars
ai-seo SKILL.md skill
furuyan1234/nano-banana-pro · .agents/skills/ai-seo/SKILL.md · When the user wants to optimize content for AI search engines, get cited by LLMs, or appear in AI-generated answers…
v1.0.0 · audit A · 20 stars
algorithmic-art SKILL.md skill
furuyan1234/nano-banana-pro · .agents/skills/algorithmic-art/SKILL.md · Creating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users…
git:20260227.0564cc7 · audit B · 20 stars
alloydb-basics SKILL.md skill
furuyan1234/nano-banana-pro · .agents/skills/alloydb-basics/SKILL.md · Manages clusters, instances, and backups for AlloyDB for PostgreSQL, and integrates with AlloyDB model context protocol…
git:20260512.7f95e61 · audit A · 20 stars
analytics-tracking SKILL.md skill
furuyan1234/nano-banana-pro · .agents/skills/analytics-tracking/SKILL.md · When the user wants to set up, improve, or audit analytics tracking and measurement. Also use when the user mentions…
v1.0.0 · audit A · 20 stars
backend-to-frontend-handoff-docs SKILL.md skill
furuyan1234/nano-banana-pro · .agents/skills/backend-to-frontend-handoff-docs/SKILL.md · Create API handoff documentation for frontend developers. Use when backend work is complete and needs to be documented…
git:20260227.0564cc7 · audit A · 20 stars
bigquery-basics SKILL.md skill
furuyan1234/nano-banana-pro · .agents/skills/bigquery-basics/SKILL.md · Manages datasets, tables, and jobs in BigQuery, and integrates with BigQuery ML and Gemini for advanced data analytics…
git:20260512.7f95e61 · audit A · 20 stars
brand-guidelines SKILL.md skill
furuyan1234/nano-banana-pro · .agents/skills/brand-guidelines/SKILL.md · Applies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having…
git:20260227.0564cc7 · audit A · 20 stars
c4-architecture SKILL.md skill
furuyan1234/nano-banana-pro · .agents/skills/c4-architecture/SKILL.md · Generate architecture documentation using C4 model Mermaid diagrams. Use when asked to create architecture diagrams…
git:20260227.0564cc7 · audit A · 20 stars
canvas-design SKILL.md skill
furuyan1234/nano-banana-pro · .agents/skills/canvas-design/SKILL.md · Create beautiful visual art in .png and .pdf documents using design philosophy. You should use this skill when the user…
git:20260227.0564cc7 · audit A · 20 stars
churn-prevention SKILL.md skill
furuyan1234/nano-banana-pro · .agents/skills/churn-prevention/SKILL.md · When the user wants to reduce churn, build cancellation flows, set up save offers, recover failed payments, or…
v1.0.0 · audit A · 20 stars
cloud-run-basics SKILL.md skill
furuyan1234/nano-banana-pro · .agents/skills/cloud-run-basics/SKILL.md · Manages Cloud Run services, jobs, and worker pools. Use when you need to deploy applications responding to HTTP…
git:20260512.7f95e61 · audit A · 20 stars

Every file in furuyan1234/nano-banana-pro

Other files named crafting-effective-readmes

crafting-effective-readmes SKILL.md skill
softaworks/agent-toolkit · skills/crafting-effective-readmes/SKILL.md · Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to…
git:20260118.011baf4 · audit A · 2,701 stars
crafting-effective-readmes SKILL.md skill
j-star-films-studios/vibecode-protocol-suite · assets/.agent/skills/agent-engineering/crafting-effective-readmes/SKILL.md · Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to…
git:20260820.4dbe9e4 · audit A · 27 stars
crafting-effective-readmes SKILL.md skill
dannykkh/skill-olympus · skills/crafting-effective-readmes/SKILL.md · Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to…
git:20260615.8873c38 · audit A · 7 stars

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

Kept in .agents/skills, the folder Codex reads. More agent skills for Codex.