readme-writing skillA
readme-writing is agent-read markdown (skill) from khaledsaeed18/dotclaude: Write or restructure a README that gets a reader from landing to first success in minutes: a one-line purpose, a working quick start verified against the actual code, then usage, configuration, and contribution pointers in the order a new user needs them, with nothing the code contradicts. Reads the repository first and never documents behaviour it has not confirmed. Use when a project has no README, when the README has drifted from the code, or before publishing a package or repository..
Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.
What the file says
A README is the front door. Its first screen must answer three questions: what is this, is it for me, how do I try it. Everything after that is in order of how soon a new user needs it. The README is verified against the code, not written from memory of the code. ## Read before writing 1. The manifest (`package.json`, `pyproject.toml`, `Cargo.toml`, `go.mod`): name, version, entry points, scripts, dependencies, engines. 2. The entry point and the public surface: CLI flags (`--help` output if it runs), exported functions, routes, config schema. 3. Existing docs, `CONTRIBUTING`, `LICENSE`, CI config, examples directory, tests (they show real usage). 4. Run the quick start you intend to document. If it does not work, the README says what actually works. ## Structure ```markdown # name One sentence: what it does and for whom. (Badges on the next line, at most four: CI, version, license, one more.) Two or three sentences: the problem it solves and the one thing that distinguishes it. Optional: a screenshot or a 10-line example that shows the payoff. ## Quick start Prerequisites in one line (runtime version, accounts, keys). …
Read the whole file at its exact version.
How to install
mdr add khaledsaeed18/dotclaude/readme-writing@git:20260921.b628018mdr add khaledsaeed18/dotclaude/readme-writing@sha256:665863b1b5efe31dPin to a label to follow the author's releases, or to a sha256 to freeze the exact bytes forever. Either way the resolved hash is written to mdr.lock, and mdr install reproduces it on any machine.
[](https://markdownregistry.com/a/art_7dpdew6okkgqezv3)
1 badge views in 30 days
Versions
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 (4059 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
khaledsaeed18/dotclaude · 5 stars · license MIT · pushed 2026-09-22 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_7dpdew6okkgqezv3 GET https://markdownregistry.com/api/v1/resolve?ref=khaledsaeed18/dotclaude/readme-writing GET https://markdownregistry.com/api/v1/blob/665863b1b5efe31d906f10b46b00efca9a47e9485b2ad346fe5ad01b90bbe670
Your agent 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.
More from khaledsaeed18/dotclaude
Every file in khaledsaeed18/dotclaude