What is github-profile-readme?

A guide for creating or rewriting a GitHub profile README, the special repository whose README appears on a user's profile page.

Adding profile banners, project and research sections, contribution graphics, statistics, contact badges, and technology labels.

It provides a consistent structure and guards against overwriting newer edits made on GitHub's website.

github-profile-readme — Skill for Claude Code and Codex by pedroiff0

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 github-profile-readme

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.

README.md

[![agentmods](https://agentmods.dev/badge/skills/pedroiff0/awesome-skills/github-profile-readme/github.svg)](https://agentmods.dev/skills/pedroiff0/awesome-skills/github-profile-readme)

Your own site

<a href="https://agentmods.dev/skills/pedroiff0/awesome-skills/github-profile-readme"><img src="https://agentmods.dev/badge/skills/pedroiff0/awesome-skills/github-profile-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.

Your own site · 80×15

<a href="https://agentmods.dev/skills/pedroiff0/awesome-skills/github-profile-readme"><img src="https://agentmods.dev/badge/skills/pedroiff0/awesome-skills/github-profile-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 76 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.

When invoked 1,982 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.

Model	Per session	Once invoked
Fable 5.1	$0.00076	$0.01982
Opus 5.5	$0.00030	$0.00793
Sonnet 5.5	$0.00015	$0.00396
Haiku 4.5	$0.00008	$0.00198

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

Security

Grade A, and why

github-profile-readme 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 1mo ago.

The scan reads SKILL.md. This mod also ships 2 executable files (scripts/gen_name_gif.py, scripts/verify-readme-assets.py), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

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.

`curl -s -o /dev/null -w "%{http_code}\n" <raw URL>` for banner SVG + both snake SVGs + every external

skills/github/github-profile-readme/SKILL.md · 97 lines

How it starts

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

GitHub Profile README (astronomy × computing theme)

Trigger: user asks to "personalize my GitHub profile README", "make my profile cool/fancy", "add stats/banner/snake to my profile", or any task touching github.com/<user>/<user> README.md.

Pre-flight

Profile repo is github.com/<user>/<user>, branch main.
ALWAYS check remote first: git fetch origin && git show origin/main:README.md. The user often edits README.md directly on github.com web after your last clone — a stale local clone is the #1 pitfall (see below).

Anatomy of a rich profile README

Animated banner (SVG) at top — see references/starfield-banner.md for a self-contained Python generator writing assets/starfield.svg (twinkling stars + constellation lines + shooting star). Embed via raw.githubusercontent URL.
Identity header: name, tagline, contact badges (shields.io for-the-badge with emoji).
"Mission"/status block — terminal-style ASCII box is a nice touch.
Stats cards. ALWAYS 200-check every external URL before embedding (see Pitfall below — popular services go down). Anchors that currently work:
- https://github-readme-activity-graph.vercel.app/graph?username=USER&theme=radical — contribution-area graph (reliable).
- https://github-readme-streak-stats.herokuapp.com/?user=USER&theme=radical — streak card (reliable).
- https://readme-typing-svg.herokuapp.com/?lines=... — animated typing headline (reliable).
- https://skillicons.dev/icons?i=python,js,nodejs,...&theme=dark&perline=9 — tech-stack icon grid (reliable; cleaner than shields badges).
- https://komarev.com/ghpvc/?username=USER&label=views — visitor counter (reliable). ⚠️ The public github-readme-stats.vercel.app (stats + top-langs) and github-profile-trophy.vercel.app instances are FREQUENTLY PAUSED/PAYWALLED (503 DEPLOYMENT_PAUSED, 402 Payment required). Do NOT embed them unless you 200-verify first. If down, self-host (fork → Vercel) or leave a hidden HTML comment with the self-host path. Full status + check loop: references/stat-services.md.
Contribution snake — GitHub Action (see references/snake-workflow.md). Publishes SVGs to an output branch; embed with <picture> + prefers-color-scheme for light/dark.
Tech badges grid (shields.io for-the-badge).
Project constellation table (markdown: project | stack | visibility | link) + research/grants table.
Footer: visitor counter (komarev.com/ghpvc), quote, links.

Read the full file on GitHub · 97 lines

Files

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.

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.

1mo ago First seen · 97 lines · 76 tokens per session scan A 37d26804c72a

Subscribe to this mod's changes

github-profile-readme is a skill published in the GitHub repository pedroiff0/awesome-skills (1 stars, last pushed 2d ago), licensed MIT. It adds 76 tokens to every session and 1,982 once invoked, about $0.0003 per session on Opus 5.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.

Code review Git and workflow Research Writing and docs agentic ai-agents awesome hermes hermes-agent skills

github-profile-readme

Getting it into your agent

Wrote this? Show the measurements

What it costs to keep this loaded

Grade A, and why

Makes network callslowCapability

How it starts

GitHub Profile README (astronomy × computing theme)

Pre-flight

Anatomy of a rich profile README

What ships with it

What this file has done since we first saw it

Other skills, from other repositories

github-pr-workflow

github-repo-audit

address-github-comments

github-workflows

github-code-review

github-code-review