readme-writer

readme-writer is a skill for Claude Code, Codex from Jignesh-Ponamwar/skills-mcp. It costs 61 tokens per session (1,099 once invoked), scanned A, original, Apache-2.0.

A guide to writing README files, the main instruction and overview document for a software project. It covers setup, examples, API references, badges, contribution instructions, and choosing a structure for different project types.

In plain words
What is it for?
Use it to create or improve documentation for libraries, command-line tools, web apps, and data or machine-learning projects, including installation and usage examples.
Why use it?
It helps developers understand, install, use, and contribute to a project without hunting through the code. It also prompts the writer to check the actual project files and avoid claiming features that are not present.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to create or improve documentation for libraries, command-line tools, web apps, and data or machine-learning projects, including installation and usage examples.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/jignesh-ponamwar/skills-mcp/readme-writer
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add Jignesh-Ponamwar/skills-mcp --skill readme-writer
Clone the repo
git clone --depth 1 https://github.com/Jignesh-Ponamwar/skills-mcp

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for readme-writer

README.md
[![agentmods](https://agentmods.dev/badge/skills/jignesh-ponamwar/skills-mcp/readme-writer/github.svg)](https://agentmods.dev/skills/jignesh-ponamwar/skills-mcp/readme-writer)
Your own site
<a href="https://agentmods.dev/skills/jignesh-ponamwar/skills-mcp/readme-writer"><img src="https://agentmods.dev/badge/skills/jignesh-ponamwar/skills-mcp/readme-writer/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for readme-writer

Your own site · 80×15
<a href="https://agentmods.dev/skills/jignesh-ponamwar/skills-mcp/readme-writer"><img src="https://agentmods.dev/badge/skills/jignesh-ponamwar/skills-mcp/readme-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 61 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,099 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00061 $0.01099
Opus 5 $0.00030 $0.00549
Sonnet 5 $0.00012 $0.00220
Haiku 4.5 $0.00006 $0.00110

Measured 11d ago against content hash 1621dd84155f, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-11, from the pricing page.

Security

Grade A, and why

readme-writer scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 11d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skill_mcp/skills_data/readme-writer/SKILL.md · 137 lines

How it starts

The opening of the file, as written. The whole thing — 137 lines — stays where its author put it; the contents beside it link to each section on GitHub.

README Writer Skill

Overview

Generate professional README.md files that give developers everything they need to understand, install, and contribute to a project - in under 5 minutes of reading.

Step-by-Step Process

Step 1: Understand the Project

Before writing, gather:

  • Project name and one-line description
  • Primary language and tech stack
  • Key features (3-5 bullet points)
  • Target audience (library authors? end users? DevOps engineers?)
  • License type
  • Whether it has tests, CI, and a live demo

Read the project's entry point, package file (package.json, pyproject.toml, go.mod), and any existing docs.

Step 2: Choose the Right README Template

Library/SDK - emphasize the API, installation, and quick start code CLI tool - emphasize installation methods and command reference Web app/service - emphasize features, screenshots, and deployment Data science / ML - emphasize datasets, training steps, and results

Step 3: Write the Header Section

# Project Name

> One-line description of what this does and who it's for.

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Python](https://img.shields.io/badge/python-3.11+-blue.svg)](https://python.org)
[![CI](https://github.com/org/repo/actions/workflows/ci.yml/badge.svg)](...)

Badges to include (pick relevant):

  • License
  • Language version (Python, Node, Go)
  • CI status
  • npm/PyPI version (for published packages)
  • Coverage (if configured)
  • Docker pulls (if published)

Step 4: Write Why It Exists (2-3 Paragraphs)

Explain the problem, the solution, and what makes this different. This is the most-skipped and most important section. Address: why would I use this instead of X?

Step 5: Write Quick Start

## Quick Start

\```bash
pip install mypackage
\```

\```python
from mypackage import Client
client = Client(api_key="...")
result = client.do_thing()
\```

The reader should be able to copy-paste and have something running in under 2 minutes.

Read the full file on GitHub · 137 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 11d ago First seen · 137 lines · 61 tokens per session scan A 1621dd84155f

Subscribe to this mod's changes

readme-writer is a skill published in the GitHub repository Jignesh-Ponamwar/skills-mcp (7 stars, last pushed 3mo ago), licensed Apache-2.0. It adds 61 tokens to every session and 1,099 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.