Diagram Design
cathrynlavery/diagram-design
Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.
Write a clear, well-structured README for a software project or open-source repo.
Install Readme Writer
$ npx skills add mohitagw15856/pm-claude-skills --skill readme-writer -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install mohitagw15856/pm-claude-skills readme-writer --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/mohitagw15856/pm-claude-skills.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/readme-writer .claude/skills/readme-writer && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "readme-writer" agent skill from https://github.com/mohitagw15856/pm-claude-skills/tree/main/skills/readme-writer into .claude/skills/readme-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-writer", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/mohitagw15856/pm-claude-skills/tree/main/skills/readme-writerType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add mohitagw15856/pm-claude-skills --skill readme-writer -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install mohitagw15856/pm-claude-skills readme-writer --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/mohitagw15856/pm-claude-skills.git skills-src && mkdir -p .agents/skills && cp -r skills-src/skills/readme-writer .agents/skills/readme-writer && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "readme-writer" agent skill from https://github.com/mohitagw15856/pm-claude-skills/tree/main/skills/readme-writer into .agents/skills/readme-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-writer", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add mohitagw15856/pm-claude-skills --skill readme-writer -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install mohitagw15856/pm-claude-skills readme-writer --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/mohitagw15856/pm-claude-skills.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/skills/readme-writer .cursor/skills/readme-writer && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "readme-writer" agent skill from https://github.com/mohitagw15856/pm-claude-skills/tree/main/skills/readme-writer into .cursor/skills/readme-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-writer", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/mohitagw15856/pm-claude-skills.git --path skills/readme-writer--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add mohitagw15856/pm-claude-skills --skill readme-writer -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install mohitagw15856/pm-claude-skills readme-writer --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/mohitagw15856/pm-claude-skills.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/skills/readme-writer .gemini/skills/readme-writer && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "readme-writer" agent skill from https://github.com/mohitagw15856/pm-claude-skills/tree/main/skills/readme-writer into .gemini/skills/readme-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-writer", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install mohitagw15856/pm-claude-skills readme-writerInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add mohitagw15856/pm-claude-skills --skill readme-writer -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/mohitagw15856/pm-claude-skills.git skills-src && mkdir -p .github/skills && cp -r skills-src/skills/readme-writer .github/skills/readme-writer && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "readme-writer" agent skill from https://github.com/mohitagw15856/pm-claude-skills/tree/main/skills/readme-writer into .github/skills/readme-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-writer", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add mohitagw15856/pm-claude-skills --skill readme-writer -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install mohitagw15856/pm-claude-skills readme-writer --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/mohitagw15856/pm-claude-skills.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/skills/readme-writer .opencode/skills/readme-writer && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "readme-writer" agent skill from https://github.com/mohitagw15856/pm-claude-skills/tree/main/skills/readme-writer into .opencode/skills/readme-writer/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "readme-writer", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
readme-writer- GitHub stars
- 1.4k
- Token cost
- ~795 tokens
- SKILL.md length
- 387 words
- Files
- 1
- Skills in repo
- 1,348
- Repo updated
- First seen
- Licence
- MIT
At a glance
Write a clear, well-structured README for a software project or open-source repo.
- Improve a README
- SKILL.md covers Required Inputs, Output Format, Quality Checks and Anti-Patterns, plus 2 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
- Document a project
What it does
Readme Writer is an agent skill from mohitagw15856/pm-claude-skills. Write a clear, well-structured README for a software project or open-source repo. Use when asked to write or improve a README, document a project, or make a repo approachable. Produces a complete README — one-line pitch, badges, quickstart, usage, install, contributing, license — that gets someone from landing to running fast.
Its SKILL.md is about 800 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Development, covering Technical documentation. The repository describes itself as: 1255 professional Agent Skills for Claude, ChatGPT, Gemini, Cursor & Codex — PRDs, postmortems, leases, medical bills, layoffs, go-bags, new countries. Plain markdown, MIT, in… The licence is MIT.
When your agent uses it
- Improve a README
- Document a project
- Make a repo approachable
Example prompts
- “/readme-writer”
What it can do on your machine
Read from SKILL.md and the folder at commit 1cbf1f0. It shows what the files ask for, not the result of running them.
Tool permissions
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Runs code
No scripts in the folder and no shell commands in SKILL.md.
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
From URLs in SKILL.md, links to its own repository left out.
Credentials
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Context cost
Readme Writer loads about 795 tokens when it runs. Until then it costs about 86 tokens; SKILL.md has 387 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
Safety
Auto-check passed
The automated check found no risky patterns in SKILL.md.
Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
SKILL.md
The full file from mohitagw15856/pm-claude-skills at commit 1cbf1f0, republished under its MIT licence (© mohitagw15856). 387 words, ~795 tokens.
Download SKILL.mdSave it as
.claude/skills/readme-writer/SKILL.md (or your agent's skills folder).- name
- readme-writer
- description
- Write a clear, well-structured README for a software project or open-source repo. Use when asked to write or improve a README, document a project, or make a repo approachable. Produces a complete README — one-line pitch, badges, quickstart, usage, install, contributing, license — that gets someone from landing to running fast.
README Writer Skill
The README is a project's front door — most people decide in seconds whether to use or bounce. This skill writes a clear, scannable README that answers what is this, why should I care, how do I run it immediately, then layers in the detail. Structured so a newcomer gets to a working result fast.
Not quite this? Use
readme-benefit-writerwhen you already have a README and want each feature rewritten as a user benefit.
Required Inputs
Ask for these only if they aren't already provided:
- Project name & one-line purpose — what it is and what problem it solves.
- Who it's for — the target user/developer.
- Install & basic usage — how to install and the simplest working example.
- Key features / differentiators — the few things that matter most.
- Project facts (optional) — language, license, links (docs, demo), contribution policy, status (alpha/stable).
Output Format
A complete README.md:
[Project name]
One-line pitch — what it does and for whom.
(Badges line — build, version, license — as placeholders to fill.)
Why [project]? — 2–3 sentences or bullets: the problem and what makes this worth using (honest, specific).
Features — the handful that matter, as a tight bullet list.
Quickstart
# install
# minimal working example…with the expected result shown.
Usage — the common cases, with short code examples. Link out to full docs rather than inlining everything.
Installation — fuller install/requirements if the quickstart was minimal.
Contributing — how to contribute / link to CONTRIBUTING; be welcoming.
License — the license line.
(Adapt sections to the project; omit what doesn't apply. Keep it scannable with clear headings.)
Show full SKILL.md (140 more words)Show less
Quality Checks
- Opens with a one-line pitch that says what it is and for whom
- A newcomer can copy-paste the quickstart to a working result
- "Why this" is specific and honest, not generic praise
- Scannable structure (headings, short sections); deep detail is linked, not dumped
- Install, usage, contributing, and license are all covered (or consciously omitted)
Anti-Patterns
- Do not bury what-it-does under a wall of badges or backstory — pitch first
- Do not write a quickstart with missing steps — it must actually run
- Do not inline the entire documentation — summarize and link
- Do not over-promise; reflect the real project status (alpha/beta/stable)
- Do not skip the license — it determines whether anyone can legally use it
Based On
Open-source README best practices (one-line pitch, time-to-first-success quickstart, scannable structure, standard sections).
Example Trigger Phrases
- "Improve a README."
- "Document a project."
- "Make a repo approachable."
© mohitagw15856, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Files
Just SKILL.md in skills/readme-writer of mohitagw15856/pm-claude-skills.
Open the folder on GitHubat commit 1cbf1f0
Compare with similar skills
Readme Writer next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Readme Writer this skillmohitagw15856/pm-claude-skills | 1.4k | — | ~795 | Automated safety check: Pass | MIT | |
| Diagram Designcathrynlavery/diagram-design | 49k | 1 repos | ~7.6k | Automated safety check: Pass | MIT | |
| Simple Englishmoeru-ai/airi | 50k | 2 repos | ~4.6k | Automated safety check: Pass | MIT | |
| Doc SyncJetBrains/ideavim | 10k | 2 repos | ~2.6k | Automated safety check: Pass | MIT | |
| Mailspring App ScreenshotsFoundry376/Mailspring | 18k | — | ~1.5k | Automated safety check: Pass | GPL-3.0 | |
| Draw.io Diagram StudioAgents365-ai/drawio-skill | 10k | — | ~2.4k | Automated safety check: Notes | MIT |
Similar skills
Simple English
moeru-ai/airi
Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.
- Official
Doc Sync
JetBrains/ideavim
Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.
Mailspring App Screenshots
Foundry376/Mailspring
Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.
Draw.io Diagram Studio
Agents365-ai/drawio-skill
Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.
Dark Architecture Diagram Builder
Cocoon-AI/architecture-diagram-generator
Creates dark-themed system, cloud, security and network architecture diagrams as self-contained HTML files with inline SVG and CSS.
More from mohitagw15856/pm-claude-skills
All 1,348 skills in this repoCar Tco
mohitagw15856/pm-claude-skills
Compare the total cost of car ownership across buy-new, buy-used, lease, and keep-your-current-car — depreciation, insurance, maintenance ramp, and fuel over a real horizon, not just the monthly…
Cs Health Scorecard
mohitagw15856/pm-claude-skills
Build a customer health scorecard for a specific account. An agent skill from mohitagw15856/pm-claude-skills.
Exit Waterfall
mohitagw15856/pm-claude-skills
Compute who gets what at each exit price from a cap table — liquidation preferences, conversion points, and where the founders' share collapses.
Feature Prioritisation
mohitagw15856/pm-claude-skills
Apply prioritisation frameworks (RICE, MoSCoW, Kano, ICE, Opportunity Scoring) to rank features and backlog items.
Fire Number
mohitagw15856/pm-claude-skills
Compute a financial-independence (FIRE) target and years-to-reach with every assumption labeled as an assumption — plus a sensitivity table instead of a single false-precision answer.
Freelance Rate
mohitagw15856/pm-claude-skills
Derive a freelance day/hourly rate backwards from target income, honest billable utilization, overhead, and the self-employment tax premium — the arithmetic that proves a rate is not salary÷2000.
Related
Categories
Questions about Readme Writer
What does Readme Writer do?
Write a clear, well-structured README for a software project or open-source repo. Readme Writer is an agent skill from mohitagw15856/pm-claude-skills. Write a clear, well-structured README for a software project or open-source repo.
When should I use Readme Writer?
Readme Writer fits situations like: improve a README; document a project; make a repo approachable.
How do I install Readme Writer in Claude Code?
Run `npx skills add mohitagw15856/pm-claude-skills --skill readme-writer -a claude-code`. Or copy the skill folder (skills/readme-writer in mohitagw15856/pm-claude-skills) into .claude/skills/readme-writer in your project. Claude Code loads it when a task matches its description.
How do I install Readme Writer in Codex?
Run `npx skills add mohitagw15856/pm-claude-skills --skill readme-writer -a codex`. Or copy the skill folder (skills/readme-writer in mohitagw15856/pm-claude-skills) into .agents/skills/readme-writer in your project. Codex loads it when a task matches its description.
Can I use Readme Writer in Cursor, Gemini CLI or GitHub Copilot?
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add mohitagw15856/pm-claude-skills --skill readme-writer -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/readme-writer, .gemini/skills/readme-writer, .github/skills/readme-writer and .opencode/skills/readme-writer in your project.
What does Readme Writer need to run?
SKILL.md names no scripts, command-line tools or credentials: Readme Writer is instructions for the agent only.
Does Readme Writer access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Readme Writer safe to install?
Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.
What licence does Readme Writer use?
Readme Writer is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
How many tokens does Readme Writer use?
About 795 tokens (SKILL.md is roughly 3.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
What are the alternatives to Readme Writer?
Skills that share tags, products or a category with Readme Writer: Diagram Design (cathrynlavery/diagram-design, 49k stars), Simple English (moeru-ai/airi, 50k stars), Doc Sync (JetBrains/ideavim, 10k stars) and Mailspring App Screenshots (Foundry376/Mailspring, 18k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Readme Writer?
mohitagw15856 (a GitHub user) maintains it in mohitagw15856/pm-claude-skills, which has 1,434 GitHub stars. The repository holds 1,348 skills in this directory. The repository was last updated on October 9, 2026.
Source: mohitagw15856/pm-claude-skills on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.