create-readme

create-readme is a skill for Claude Code, Codex from OKHP3/skillz. It costs 12 tokens per session (311 once invoked), scanned A, a copy of create-readme, MIT.

A tool for writing a project's README.md, the main guide that explains a repository to its users and contributors.

In plain words
What is it for?
Use it to document what a project does, how to set it up, and how to work with it.
Why use it?
It turns the existing project into a structured, readable starting point for people who need to understand or use it.

Skill for Claude CodeCodex

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

Good fit Use it to document what a project does, how to set it up, and how to work with it.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/okhp3/skillz/create-readme
View source ↗ OKHP3/skillz
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 OKHP3/skillz --skill create-readme
Clone the repo
git clone --depth 1 https://github.com/OKHP3/skillz

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 create-readme

README.md
[![agentmods](https://agentmods.dev/badge/skills/okhp3/skillz/create-readme/github.svg)](https://agentmods.dev/skills/okhp3/skillz/create-readme)
Your own site
<a href="https://agentmods.dev/skills/okhp3/skillz/create-readme"><img src="https://agentmods.dev/badge/skills/okhp3/skillz/create-readme/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 create-readme

Your own site · 80×15
<a href="https://agentmods.dev/skills/okhp3/skillz/create-readme"><img src="https://agentmods.dev/badge/skills/okhp3/skillz/create-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 12 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 311 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 100% copy Near-identical to another mod 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.00012 $0.00311
Opus 5.5 $0.00005 $0.00124
Sonnet 5.5 $0.00002 $0.00062
Haiku 4.5 $0.00001 $0.00031

Measured 1mo ago against content hash a93f9161bef3, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

create-readme 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 1mo 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.

Origin

This is a copy

100% identical to create-readme — 0 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

community/create-readme/SKILL.md · 22 lines

What it actually says

Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

Task

  1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
  2. Take inspiration from these readme files for the structure, tone and content:
  3. Do not overuse emojis, and keep the readme concise and to the point.
  4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
  5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
  6. If you find a logo or icon for the project, use it in the readme's header.
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. 1mo ago First seen · 22 lines · 12 tokens per session scan A a93f9161bef3

Subscribe to this mod's changes

create-readme is a skill published in the GitHub repository OKHP3/skillz (3 stars, last pushed 2d ago), licensed MIT. It adds 12 tokens to every session and 311 once invoked, about $0.0000 per session on Opus 5.5. A static security scan graded it A with 0 findings. It is 100% identical to create-readme, differing in 0 lines, and is treated as a copy.

Related

Other skills, from other repositories

baoyu-youtube-transcript

A tool for downloading the written captions, subtitles, chapter information, speaker labels, and cover image from a YouTube video using its URL or ID.

JimLiu/baoyu-skills · 107 tokens

baoyu-url-to-markdown

Fetch any URL and convert to markdown using baoyu-fetch CLI (Chrome CDP with site-specific adapters). Built-in adapters for X/Twitter, YouTube transcripts, Hacker News threads, and generic pages via Defuddle. Handles login/CAPTCHA via interaction wait modes. Use when user wants to save a webpage as markdown.

JimLiu/baoyu-skills · 72 tokens

obsidian-markdown

A Markdown writing workflow for Obsidian, a note-taking app that can link notes together. It supports features such as two-way links, callouts, frontmatter, embedded content, and wikilinks.

anbeime/skill · 73 tokens

obsidian-skills-integrated

A skill for writing and editing Obsidian notes while preserving Obsidian-specific formats. Obsidian is a note-taking app that supports links between notes, callouts, databases, and visual canvases.

anbeime/skill · 74 tokens

PDF Processing Pro

A PDF-processing workflow for handling forms, extracting tables, and using OCR to turn scanned text into searchable data. It also performs automated data checks using built-in scripts.

anbeime/skill · 76 tokens

pptx-generator

A tool that converts JSON data, a structured text format often used by software, into standard .pptx presentation files. It applies layouts and can format charts and tables.

anbeime/skill · 69 tokens