readme-template

readme-template is a skill for Claude Code, Codex from pedroiff0/awesome-skills. It costs 72 tokens per session (2,464 once invoked), scanned A, original, MIT.

A reusable outline for writing a complete professional README, the main documentation page for a software repository.

In plain words
What is it for?
Creating or rewriting README files with project overviews, installation and configuration instructions, tests, documentation, roadmaps, licensing, author details, badges, and repository activity sections.
Why use it?
It prevents important setup, testing, security, structure, and contribution information from being omitted.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one. Also seen: mentions AGENTS.md.

Good fit Creating or rewriting README files with project overviews, installation and configuration instructions, tests, documentation, roadmaps, licensing, author details, badges, and repository activity sections.

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

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/pedroiff0/awesome-skills/readme-template"><img src="https://agentmods.dev/badge/skills/pedroiff0/awesome-skills/readme-template.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 72 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,464 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. 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.00072 $0.02464
Opus 5 $0.00036 $0.01232
Sonnet 5 $0.00014 $0.00493
Haiku 4.5 $0.00007 $0.00246

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

Security

Grade A, and why

readme-template scanned grade A with 1 finding 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.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

1. `curl -s -o /dev/null -w "%{http_code}\n" <star-history-url>` → expect 200.
skills/github/readme-template/SKILL.md · 245 lines

How it starts

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

README Template — professional repo standard

Build a professional, rich README for any repository. Combines the financas-app structure with RepoActivity sections (Star History, badges) and the pedroiff0 profile GIF footer.

Trigger

User asks to "create a README", "write a README for repo X", "rewrite my README", "make a professional README", or any task that produces a README.md for a repo.

Source examples

  • financas-app README (financas-app/README.md): hero logo, screenshots grid, index, modules table, stack table, features list, demo, install, config, docker, tests, security, structure, docs, roadmap, contribute, license, author.
  • Awesome Credential-Verification-Platform (ishandutta2007/...): centered banner + shields badges, overview, table of contents, comparative tables, how-to-contribute, star history chart, disclaimer — the "RepoActivity" sections.
  • Profile GIF: https://raw.githubusercontent.com/pedroiff0/pedroiff0/main/assets/pedroiff0.gif

Anatomy of the README

1. Header (centered)

<div align="center">

<img src="PATH_TO_LOGO" alt="Project Logo" width="120" height="120"/>

> One-line tagline describing the project.

</div>

2. Badges (shields.io — centered, right after header)

Row of flat-square or for-the-badge shields:

  • License
  • Stars / Forks
  • PRs welcome
  • Version / Release
  • Build status (if CI on)
  • Follow / social
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" alt="License"/></a>
<a href="stargazers"><img src="https://img.shields.io/github/stars/OWNER/REPO?style=flat-square&color=gold" alt="Stars"/></a>

3. Screenshots / Demo GIF

<div align="center">

**Tour / Demo**

<img src="docs/assets/demo-tour.gif" alt="Demo" width="900"/>

</div>

4. Table of Contents

  • O que é / About
  • Módulos / Features
  • Stack Técnica
  • Funcionalidades
  • Demo
  • Instalação / Quick Start
  • Configuração
  • Docker (if applicable)
  • Testes
  • Segurança / Security
  • Estrutura do Projeto
  • Documentação
  • Roadmap
  • Contribuição
  • Licença
  • Autor

Read the full file on GitHub · 245 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 · 245 lines · 72 tokens per session scan A 1464d8eaf596

Subscribe to this mod's changes

readme-template is a skill published in the GitHub repository pedroiff0/awesome-skills (1 stars, last pushed 3d ago), licensed MIT. It adds 72 tokens to every session and 2,464 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). 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