readme-writer
Skill24 starsChanged 28 days agoMITView on GitHub
Write or rewrite a repository README to a high standard with hero banner, badges, real screenshot, quick start, config table, and architecture diagram. Use for any README task.
23 other projects use a version of this.
Adopted by
Most recently taken up by
- sandrinodm/skillstheir own version, first seen Nov 8, 2026
- vigneshm1995personal/skillgatetheir own version, first seen Nov 8, 2026
- andymartinezot/claude-skillstheir own version, first seen Nov 1, 2026
- nseney1/Soma-Governancetheir own version, first seen Nov 1, 2026
- OneByJorah/VirtOfficeword for word, first seen Nov 1, 2026
- vrodokanakis/claude-skillstheir own version, first seen Oct 25, 2026
Used with
Projects with it also use security-audit.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
CloudflareSkillsecurity-audit
Security guidance and vulnerability review for codebases, APIs, services, CLI tools, libraries, and daemons. Use for security questions, focused reviews, vulnerability research, security audits, or pen tests. Run the complete workflow only for explicit codebase audit or pen-test requests, full/comprehensive/end-to-end reviews, or requested report artifacts.
Also in 3 projects that use this
Other versions23 projects use a version of this.
Word for word · 1
- OneByJorah/VirtOffice★ 24100% same
Edited · 0
None found.
Wrote their own version · 22
- event-driven-io/emmett★ 562same name
- sandrinodm/skills★ 11same name
- nseney1/Aegis-Guardrails★ 4same name
- nseney1/Soma-Governance★ 4same name
- shimo4228/claude-harness★ 4same name
- WST2002/claude-code-skills★ 4same name
- guihai24/openskills★ 2same name
- IdkwhatImD0ing/hackathonstarterkit★ 2same name
- brpaz/agent-skills★ 1same name
- ChenYiming-aaa/readme-writer★ 1same name
12 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository7 other files it gives its agents.
- AGENTS.mdAGENTS.md
- dockerizeSkill
- pr-workflowSkill
- release-checklistSkill
- repo-polishSkill
- screenshot-captureSkill
- security-scrubSkill
The file
We split this skill into the rules it gives an agent
2 rules. 0 are common, 2 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 17 edited versions we read keep these.
2
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 27
Run every command in the README on a clean clone.
- Distinctive: line 28
Check every link and image path.
“Common” is measured: kept by at least 6 in 10 of the 17 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
readme-writer
Structure (in this order)
- Hero banner (
docs/assets/banner.svg) and one-line pitch - Badges: CI, release, license, GHCR image, stars
- A real screenshot directly under the pitch
- Why this exists: 3 to 4 sentences
- Features: specific, each with its outcome
- Quick start: copy-paste block that works in under two minutes
- Configuration: table of environment variables with defaults
- Architecture: a Mermaid diagram of the real components
- Roadmap, Contributing, Security, License
Voice
Calm, direct, specific. First person plural or neutral. No hype words ("blazing", "revolutionary"), no filler, no emoji spam.
Rules
- Describe only what the code actually does. Read it first. Never invent features.
- Run every command in the README on a clean clone. Fix the README or the code if it fails.
- Check every link and image path.
- Replace every placeholder from the template (
VirtOffice,Project Name, "One-line pitch"). - Design colors for banners and diagrams: background
#0a0a09, accent#FFB300, font JetBrains Mono. - Lint with
markdownlint-cli2.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.