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.

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.

agentmods
npx agentmods add skills/okhp3/skillz/create-readme
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.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.svg" alt="Measured on agentmods" 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. Scan, not verified.
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 $0.00006 $0.00156
Sonnet 5 $0.00002 $0.00062
Haiku 4.5 $0.00001 $0.00031

Measured 2d ago against content hash a93f9161bef3, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, 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 2d 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. 2d 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 today), licensed MIT. It adds 12 tokens to every session and 311 once invoked, about $0.0001 per session on Opus 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

Downloads YouTube video transcripts/subtitles and cover images by URL or video ID. Supports multiple languages, translation, chapters, and speaker identification. Caches raw data for fast re-formatting. Use when user asks to "get YouTube transcript", "download subtitles", "get captions", "YouTube字幕", "YouTube封面"…

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

pm-preview

产品文档实时预览 - 在浏览器中预览 docs/ 下的所有 MD 文档,文档更新时自动刷新 Use when: 需要预览产品文档、查看 PRD/BRD/MRD 等 MD 文档的渲染效果 Do NOT use when: 文档尚未生成(docs/ 为空).

konglong87/superPM · 77 tokens

obsidian-skills-integrated

内容创作者与技术写作员在让AI撰写Obsidian笔记时,使用此官方技能可精准处理双链、Callout及Bases数据库语法,一键生成格式零破坏的Canvas画布与专业笔记,彻底解决AI破坏专属格式的痛点。.

anbeime/skill · 74 tokens

obsidian-markdown

技术写作员与内容创作者在构建Obsidian知识库时,当需要编写带双向链接、Callout或Frontmatter的复杂笔记,使用此技能可精准生成标准Markdown文档,完美支持wikilinks与嵌入,大幅提升知识管理与排版效率!.

anbeime/skill · 73 tokens

PDF Processing Pro

综合办公文员与软件开发工程师当需要批量处理PDF表单、提取表格或进行OCR识别时,使用内置脚本一键完成自动化提取与数据校验,彻底告别繁琐的手动录入,让复杂文档工作流高效、稳健落地。.

anbeime/skill · 76 tokens