readme-writing

readme-writing is a skill for Claude Code, Codex from easyzoom/aix-skills. It costs 17 tokens per session (866 once invoked), scanned A, original, MIT.

A writing guide for README files, the main introduction and quick-start document in a public code repository. It focuses on helping readers understand a project, trust its instructions, and try it without guessing.

In plain words
What is it for?
Use it to create or improve a public repository's README. It helps write project introductions, installation and quick-start instructions, contribution sections, visuals, badges, and language links.
Why use it?
It removes uncertainty about what the project does, who it is for, how to start, and how to contribute. It also helps organize setup steps, screenshots, diagrams, badges, and related information clearly.

Skill for Claude CodeCodex

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

Good fit Use it to create or improve a public repository's README. It helps write project introductions, installation and quick-start instructions, contribution sections, visuals, badges, and language links.

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

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-writing

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/easyzoom/aix-skills/readme-writing"><img src="https://agentmods.dev/badge/skills/easyzoom/aix-skills/readme-writing.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 17 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 866 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.00017 $0.00866
Opus 5 $0.00009 $0.00433
Sonnet 5 $0.00003 $0.00173
Haiku 4.5 $0.00002 $0.00087

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

Security

Grade A, and why

readme-writing 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.

skills/readme-writing/SKILL.md · 121 lines

How it starts

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

README Writing

Overview

Write README files that help a visitor understand the project in the first screen, trust it within one minute, and try it without guessing. A good README is a landing page, setup guide, and trust signal at the same time.

When To Use

Use this skill when:

  • Creating a new README.md.
  • Rewriting a README for a public repository.
  • Improving a README's clarity, structure, visuals, or quickstart.
  • Adding badges, screenshots, diagrams, language links, or contribution sections.
  • Making a repository more attractive for GitHub readers.

Do not use it for long-form product docs, API references, or internal-only runbooks unless the user specifically wants a README-style entry page.

Workflow

  1. Identify the primary reader. Decide whether the README is for users, developers, contributors, evaluators, or agents. Put the most important reader first.

  2. Write the first screen. Include project name, one-sentence value proposition, optional language links, visual banner or screenshot, and trust badges.

  3. Explain the project quickly. State what it does, who it is for, and why it is different. Avoid marketing fluff that does not help someone decide whether to continue.

  4. Show the fastest path to value. Provide a short quickstart with commands that can be copied. Include expected output when it reduces uncertainty.

  5. Show structure and capabilities. List key directories, features, or modules. Use tables for scanability when comparing multiple items.

  6. Add proof. Include screenshots, SVG diagrams, badges, test commands, examples, or links to demos. Prefer local assets for long-lived public repos.

  7. Cover contribution and license. Link to contribution docs, issue templates, validation commands, and license.

  8. Verify the README. Check links, commands, image paths, and consistency with the actual repository.

# Project Name

Language links, badges, and hero image.

One-sentence value proposition.

## Why This Exists
## Features
## Quickstart
## Examples
## Project Structure
## Contributing
## License

Read the full file on GitHub · 121 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 · 121 lines · 17 tokens per session scan A 8d63ef7dda3f

Subscribe to this mod's changes

readme-writing is a skill published in the GitHub repository easyzoom/aix-skills (31 stars, last pushed 1mo ago), licensed MIT. It adds 17 tokens to every session and 866 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-30.

Related

Other skills, from other repositories

resume-writer

Rewrite and enhance resumes using a persistent library of principles harvested from real recruiters, hiring managers, and HR professionals. Always trigger immediately when the user's message starts with "rw". Also trigger on "resume writer", "rewrite my resume", "enhance my resume", "fix my resume", "review my…

mickpletcher/AI-Skills · 222 tokens

trip-email-html-itinerary

Extract trip logistics from pasted travel emails, booking confirmations, forwarded messages, reservation notes, or raw itinerary text, research useful restaurant and activity suggestions for each destination, and generate one polished, self-contained offline HTML itinerary file for sharing with family or other…

mickpletcher/AI-Skills · 98 tokens

facebook-post

Write and polish Facebook posts on any topic. Trigger on requests to draft, rewrite, polish, improve a Facebook post, or create cross-platform Facebook, X, and LinkedIn bundles, especially when the user starts with fbp.

mickpletcher/AI-Skills · 50 tokens

fitness-log

Track workouts, log fitness progress, adjust the training program, and generate Facebook posts from workout data. Trigger on workout logging, PR updates, program questions, and fitness progress summaries.

mickpletcher/AI-Skills · 39 tokens

idea-forge

Run any raw idea through a multi-stage R&D pipeline that interprets, expands, scores, and converts it into an actionable engineering plan. Always trigger immediately when the user's message starts with "idea". Also trigger on "ideaforge", "analyze this idea", "expand this concept", "assess this invention", "explore…

mickpletcher/AI-Skills · 118 tokens

travel-itinerary

Plan, format, and export travel itineraries as Obsidian-formatted Markdown files. Always trigger immediately when the user's message starts with "trip" or "itinerary". Also trigger when the user says "plan my trip", "build my itinerary", "travel plan", "export my trip", "format this itinerary", or describes an…

mickpletcher/AI-Skills · 109 tokens