Home / wst2002 / claude-code-skills · GitHub

readme-writer SKILL.md skillA

readme-writer from wst2002/claude-code-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned

mdr add wst2002/claude-code-skills/readme-writer@git:20261016.55bd98a

Pins git:20261016.55bd98a in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: wst2002/claude-code-skills
Path: skills/readme-writer/SKILL.md
Versions recorded: 2
Latest version: git:20261016.55bd98a, committed Oct 16, 2026
First version recorded: Oct 16, 2026
Size: 2,657 bytes
Repository stars: 3
License: MIT

Use when writing a README, improving or rewriting an existing README.md, documenting a project for new users or contributors, or preparing a repository to be published or open-sourced.

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 Writer

## Overview

A README answers, in order: what is this, why should I care, how do I run it in five minutes, and where do I go next. Every fact comes from the codebase. Nothing is invented.

## Method

1. **Collect facts from the code** before writing a word:
   - Manifests: `package.json`, `pyproject.toml`, `pom.xml`, `go.mod`, `Cargo.toml` — name, description, scripts, engines/versions.
   - Entry points, CLI flags (`--help` output if runnable), exported API.
   - Configuration: `.env.example`, config files, required environment variables.
   - Setup steps hidden in scripts, Dockerfiles, Makefiles and CI workflows.
   - License file, contributing guide, existing docs.
2. **Verify every command** you will document exists (script name, binary, flag). Do not document `npm run dev` unless the script is there.
3. **Pick the audience:** users of a library or CLI, operators of a service, or contributors. Lead with what that audience needs.
4. **Write** using [template.md](template.md). Drop sections that have no real content.
5. **Mark unknowns.** If a fact cannot be found (deployment URL, support channel), leave a clearly marked `TODO:` or ask; never guess.

## Rules
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add wst2002/claude-code-skills/readme-writer@sha256:6a5e4805f9c4e19b

The line at the top of this page pins the label git:20261016.55bd98a, 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](https://markdownregistry.com/badge/art_yr6d3qd7q3ljn6ez.svg)](https://markdownregistry.com/a/art_yr6d3qd7q3ljn6ez)

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

Versions

The registry has recorded 2 versions of this file, all committed on Oct 16, 2026.

version	committed	commit	size	audit
git:20261016.55bd98a latest	2026-10-16	55bd98a	2,657 B	A	view · diff
git:20261016.c3a2cef	2026-10-16	c3a2cef	2,455 B	A	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 (2657 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

wst2002/claude-code-skills · 3 stars · license MIT · pushed 2026-10-19 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_yr6d3qd7q3ljn6ez
GET https://markdownregistry.com/api/v1/resolve?ref=wst2002/claude-code-skills/readme-writer
GET https://markdownregistry.com/api/v1/blob/6a5e4805f9c4e19b42ab6a774c2252b6ad0446ac90705f7ea8db38c3dca0e51a

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 wst2002/claude-code-skills

proof-of-done SKILL.md skill

wst2002/claude-code-skills · plugins/proof-of-done/skills/proof-of-done/SKILL.md · Use before saying work is done, fixed, or complete after changing code. Run the project's checks, show their results…