Borrowing it
Nothing to install: this file belongs to debs-obrien/learn-agent-skills. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/debs-obrien/learn-agent-skills/main/.agents/skills/readme-wizard/SKILL.mdgit clone --depth 1 https://github.com/debs-obrien/learn-agent-skillsWrote 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.
[](https://agentmods.dev/skills/debs-obrien/learn-agent-skills/readme-wizard)<a href="https://agentmods.dev/skills/debs-obrien/learn-agent-skills/readme-wizard"><img src="https://agentmods.dev/badge/skills/debs-obrien/learn-agent-skills/readme-wizard/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.
<a href="https://agentmods.dev/skills/debs-obrien/learn-agent-skills/readme-wizard"><img src="https://agentmods.dev/badge/skills/debs-obrien/learn-agent-skills/readme-wizard.svg" alt="Reviewed on agentmods" width="80" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.00177 | $0.00944 |
| Opus 5.5 | $0.00071 | $0.00378 |
| Sonnet 5.5 | $0.00035 | $0.00189 |
| Haiku 4.5 | $0.00018 | $0.00094 |
Grade A, and why
readme-wizard 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 2mo 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.
How it starts
The opening of the file, as written. The whole thing — 62 lines — stays where its author put it; the contents beside it link to each section on GitHub.
README Wizard
Generate or improve a project's README by scanning the repo and producing a polished, professional result based on real project data.
Workflow
1. Scan the project
Run scripts/scan_project.sh <project-directory> to collect structured JSON metadata:
- Project name and description
- License type
- Git remote (owner and repo name)
- Package manager (npm, yarn, pnpm, pip, cargo, go, etc.)
- CI setup (provider and workflow files)
- Social links (YouTube, Discord, Twitter, LinkedIn, Bluesky, Twitch)
- Directory structure (top 2 levels)
The reference script checks local files first, then uses the GitHub API to look up the homepage URL and crawls that homepage for additional social links. Your own first version can stay local-file only and add this enrichment later if you want it.
Handling missing data: The scan will return empty strings for anything it can't find. Never fabricate metadata — if a field is empty, skip the related section or badge entirely. For example: no CI workflows means no build badge; no social links means no social section.
2. Read the best practices guide
Read references/readme-best-practices.md before writing. It covers structure, tone, project-type adaptation, and common pitfalls. This context makes a real difference in output quality — the guide explains the reasoning behind each section so you produce READMEs that feel intentional rather than formulaic.
3. Build the README
Use assets/readme-template.md as the base structure. Replace {{PLACEHOLDER}} markers with actual project data from the scan.
When rendering the project tree, keep it close to how people browse repos: list directories before files, alphabetize within each group, and add trailing / markers for directories.
Adapt — don't copy blindly. The template is a starting point. Drop sections that don't apply (e.g., no Contributing section for a personal notes repo) and adjust the tone to match the project:
- Libraries/frameworks: Focus on installation, API, and examples
- Applications: Focus on setup, configuration, and screenshots
- Docs/learning repos: Focus on structure and navigation
- Small utilities/scripts: Keep it short — hero + what it does + usage is enough
What ships with it
6 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.
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.
- 2mo ago First seen · 62 lines · 177 tokens per session scan A cdca27fe7851
readme-wizard is a skill published in the GitHub repository debs-obrien/learn-agent-skills (53 stars, last pushed 7mo ago), licensed MIT. It adds 177 tokens to every session and 944 once invoked, about $0.0007 per session on Opus 5.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.
readme-wizard compared with skills from other repositories
| Mod | Type | Stars | Last push | Licence | Scan | Tokens | Works with |
|---|---|---|---|---|---|---|---|
| readme-wizarddebs-obrien/learn-agent-skills | Skill | 53 | 7mo ago | MIT | A | 177 | Claude Code, Codex |
| imagegenopenai/codex | Skill | 133k | yesterday | Apache-2.0 | A | 113 | Codex |
| playwright-climicrosoft/playwright | Skill | 99k | yesterday | Apache-2.0 | A | 19 | Claude Code |
| local-ai-agentsmicrosoft/ai-agents-for-beginners | Skill | 79k | 4d ago | MIT | A | 200 | Claude Code, Codex |
| systematic-debuggingobra/superpowers | Skill | 313k | 3d ago | MIT | A | 21 | Claude Code |
| next-cache-components-adoptionvercel/next.js | Skill | 143k | yesterday | MIT | A | 95 | Claude Code |
| next-partial-prefetching-adoptionvercel/next.js | Skill | 143k | yesterday | MIT | A | 103 | Claude Code |