README Writer

README Writer is a skill for Claude Code, Codex from Notysoty/openagentskills. It costs 21 tokens per session (1,530 once invoked), scanned A, original, MIT.

A documentation-writing skill that creates a complete README.md, the main guide explaining a software project to users and contributors.

In plain words
What is it for?
Use it to document command-line tools, web apps, libraries, or frameworks from their code and existing descriptions.
Why use it?
It removes the need to understand every project file before writing setup, usage, and contribution instructions.

Skill for Claude CodeCodex

Which agent this was written for is unclear — built for cline. Also seen: mentions Claude Code; mentions Codex; built for cline.

Good fit Use it to document command-line tools, web apps, libraries, or frameworks from their code and existing descriptions.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/notysoty/openagentskills/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 Notysoty/openagentskills --skill readme-writer
Clone the repo
git clone --depth 1 https://github.com/Notysoty/openagentskills

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/notysoty/openagentskills/readme-writer/github.svg)](https://agentmods.dev/skills/notysoty/openagentskills/readme-writer)
Your own site
<a href="https://agentmods.dev/skills/notysoty/openagentskills/readme-writer"><img src="https://agentmods.dev/badge/skills/notysoty/openagentskills/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/notysoty/openagentskills/readme-writer"><img src="https://agentmods.dev/badge/skills/notysoty/openagentskills/readme-writer.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 21 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,530 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.00021 $0.01530
Opus 5 $0.00010 $0.00765
Sonnet 5 $0.00004 $0.00306
Haiku 4.5 $0.00002 $0.00153

Measured 10d ago against content hash 30dc550ec3d8, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, 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 10d 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.

skills/readme-writer/SKILL.md · 143 lines

How it starts

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

README Writer

What this skill does

This skill directs the agent to read a project's structure, package.json (or equivalent manifest), source files, and any existing documentation, then generate a complete, professional README.md. The output adapts its tone and structure to the type of project — a CLI tool, a web app, a library, or a framework — and covers everything a new user or contributor needs to get started.

Use this when you have a new project without documentation, an outdated README, or an open-source project you want to present well.

How to use

Claude Code / Cline

Copy this file to .agents/skills/readme-writer/SKILL.md in your project root.

Then ask:

  • "Use the README Writer skill to generate a README for this project."
  • "Write a professional README.md for this repo using the README Writer skill."

The agent will explore the project structure on its own. You can also provide a description of what the project does if the code alone isn't self-explanatory.

Cursor

Add the "Prompt / Instructions" section to your .cursorrules file. Then open the relevant files (package.json, main entry point) and ask Cursor to write the README.

Codex

Paste your package.json (or equivalent), the main entry file, and a brief description of the project. Then include the instructions below.

The Prompt / Instructions for the Agent

When asked to write a README, follow these steps:

  1. Gather information. Read:

    • package.json, pyproject.toml, Cargo.toml, go.mod, or equivalent manifest for name, description, version, dependencies, and scripts
    • The main entry point file to understand the project's purpose
    • Any existing README.md, CHANGELOG.md, or docs/ folder
    • The directory structure (top level) to understand the project layout
    • LICENSE file to identify the license
  2. Determine the project type and adapt accordingly:

    • Library/Package — focus on API reference, installation, and code examples
    • CLI tool — focus on installation, commands, flags, and usage examples
    • Web application — focus on features, setup, and deployment
    • Framework/boilerplate — focus on getting started, conventions, and architecture

Read the full file on GitHub · 143 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. 10d ago First seen · 143 lines · 21 tokens per session scan A 30dc550ec3d8

Subscribe to this mod's changes

README Writer is a skill published in the GitHub repository Notysoty/openagentskills (9 stars, last pushed 26d ago), licensed MIT. It adds 21 tokens to every session and 1,530 once invoked, about $0.0001 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.

Related

Other skills, from other repositories

absolute-docs

Diátaxis-driven documentation for AI coding agents: write, improve, or audit tutorials, how-tos, reference, explanation, and developer docs (README, CONTRIBUTING, ADRs). Detects the docs stack; gates on the outline before writing prose; verifies every claim against the code before it ships. Triggers on "absolute…

maddhruv/absolute · 102 tokens

public-repo-creation

Create production-ready public GitHub repositories with comprehensive documentation, automated setup, and quality assurance.

kevinnft/ai-agent-skills · 23 tokens

skill-builder

Automatically detect source types and build AI skills using Skill Seekers. Use when the user wants to create skills from documentation, repos, PDFs, videos, or other knowledge sources.

yusufkaraaslan/Skill_Seekers · 38 tokens

extract-source-sample

Given the path to a finished content-goose ad-run folder, extract everything that defines that ad — recipe shot list, VO script, characters, voices, world, atom-skills, master mp4 — and emit a source-sample.json in the exact shape the upload-ad-sample skill writes to the Goose Ads library. Also links every character…

gooseworks-ai/goose-skills · 160 tokens

comprehensive-enrichment

Enrich any person or company from any identifier — email, name, LinkedIn URL, domain, company name, Twitter/X handle. Use when asked to enrich, look up, or research a lead, contact, person, or company.

gooseworks-ai/goose-skills · 53 tokens

google-search-ads-builder

End-to-end Google Search Ads campaign builder. Performs deep keyword research (competitor SEO, review language mining, Reddit/HN community terminology, site audit), builds keyword architecture with funnel mapping and intent classification, creates ad group structure, generates headline/description variants, builds…

gooseworks-ai/goose-skills · 79 tokens