project-readme

project-readme is a skill for Claude Code, Codex from Firstp1ck/pi-coding-agent-forge. It costs 49 tokens per session (3,995 once invoked), scanned A, original, MIT.

A guide for creating and reviewing a repository's README, the main document that explains a project to its users or developers. It bases the README on verified information from the local codebase.

In plain words
What is it for?
Use it to create a missing README, update or reorganize an existing one, or check whether it follows the project's documentation rules.
Why use it?
It helps turn project details into a clear starting point without adding unsupported claims or treating every project as if it had the same documentation needs.

Skill for Claude CodeCodex

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

Good fit Use it to create a missing README, update or reorganize an existing one, or check whether it follows the project's documentation rules.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/firstp1ck/pi-coding-agent-forge/project-readme
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 Firstp1ck/pi-coding-agent-forge --skill project-readme
Clone the repo
git clone --depth 1 https://github.com/Firstp1ck/pi-coding-agent-forge

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 project-readme

README.md
[![agentmods](https://agentmods.dev/badge/skills/firstp1ck/pi-coding-agent-forge/project-readme/github.svg)](https://agentmods.dev/skills/firstp1ck/pi-coding-agent-forge/project-readme)
Your own site
<a href="https://agentmods.dev/skills/firstp1ck/pi-coding-agent-forge/project-readme"><img src="https://agentmods.dev/badge/skills/firstp1ck/pi-coding-agent-forge/project-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.

agentmods 80×15 button for project-readme

Your own site · 80×15
<a href="https://agentmods.dev/skills/firstp1ck/pi-coding-agent-forge/project-readme"><img src="https://agentmods.dev/badge/skills/firstp1ck/pi-coding-agent-forge/project-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 49 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 3,995 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. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
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.00049 $0.03995
Opus 5.5 $0.00020 $0.01598
Sonnet 5.5 $0.00010 $0.00799
Haiku 4.5 $0.00005 $0.00400

Measured 22d ago against content hash 17e433d0ee4d, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

project-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 22d ago.

The scan reads SKILL.md. This mod also ships 1 executable file (tests/test_skill_contract.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.

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.

pi-skill-project-readme/skills/project-readme/SKILL.md · 225 lines

How it starts

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

Project README

Create or assess a useful project entry point from repository evidence. Adapt the bundled templates to the project's readers and local rules rather than treating them as mandatory section checklists. Offer companion documents when evidence supports them, and ask the user before creating either file. This skill is guidance, not a runtime guard, and loading it does not install, enable, publish, or modify anything by itself.

When to Use

Use this skill for a repository-level request to:

  • create a missing project README;
  • update, restructure, or harmonize an existing project README;
  • audit or review a project README against repository evidence and documentation policy; or
  • create separately approved TECHNICAL.md and DEVELOPMENT.md companions as part of the README task.

Do not use it for:

  • general copywriting, release notes, blog posts, or arbitrary Markdown cleanup;
  • writing API references, contributor guides, security policies, or package metadata as the primary task;
  • changing implementation, packaging, publication, installation, or runtime configuration;
  • rewriting many repositories or sibling projects without explicit per-destination scope;
  • reviewing code quality when the project README is not the requested artifact.

Should trigger

  • “Create the top-level README for this application from the repository contents.”
  • “Update this library README with a verified quick start and public documentation links.”
  • “Review our project README for unsupported claims and misplaced contributor details.”
  • “Harmonize this repository README with its local documentation rules.”

Should not trigger

  • “Write an API endpoint reference for this service.”
  • “Fix the implementation and add tests.”
  • “Draft release notes for the next version.”
  • “Reformat every Markdown file in the organization.”

Ambiguous requests

A request such as “improve the docs” does not establish the artifact or write scope. Determine whether the user means the project README; otherwise route to the documentation workflow matching the actual artifact. A request to “document this package” may need a user-facing project README, an API reference, contributor documentation, or several separately scoped documents. Do not silently widen it.

Read the full file on GitHub · 225 lines

Files

What ships with it

5 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.

  1. 22d ago Changed · +27 lines · +14 tokens per session 17e433d0ee4d
  2. 1mo ago First seen · 198 lines · 35 tokens per session scan A 330652a3f67f

Subscribe to this mod's changes

project-readme is a skill published in the GitHub repository Firstp1ck/pi-coding-agent-forge (91 stars, last pushed yesterday), licensed MIT. It adds 49 tokens to every session and 3,995 once invoked, about $0.0002 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.

Related

Other skills, from other repositories

convex-component-authoring

How to create, structure, and publish self-contained Convex components with proper isolation, exports, and dependency management.

waynesutton/convexskills · 28 tokens

npm-docs

Use this skill whenever the user asks about npm, package management, publishing packages, semantic versioning, npm CLI commands, or Node.js dependencies. Covers npm 12.x including the registry, scopes, organizations, security (audit, provenance, 2FA), CI/CD integration, workspaces, scripts, .npmrc configuration, and…

pledgeandgrow/pledge-skills · 91 tokens

convex-component-authoring

How to create, structure, and publish self-contained Convex components with proper isolation, exports, and dependency management.

J-StaR-Films-Studios/VibeCode-Protocol-Suite · 28 tokens

dependency-manager

Manage project dependencies — update packages, audit vulnerabilities, resolve conflicts, and keep dependencies healthy. Use when updating packages, fixing vulnerability alerts, or resolving dependency issues.

asgarovf/locusai · 35 tokens

colab-finetuning

Fine-tune LLMs on Google Colab GPUs directly from openscience. Connects to Colab runtimes via WebSocket bridge for remote training with Unsloth. Supports SFT, GRPO, DPO, vision, and TTS workflows on free T4 to Pro A100 GPUs.

synthetic-sciences/openscience · 67 tokens

swarm-pr-review

Run a graph-guided, tool-augmented PR review using context packing, parallel exploration, mandatory repository-agnostic risk-family coverage with dispatch scaled to diff size and risk, independent reviewer validation, critic challenge, and metrics writeback. Use for deep pull request review with low false-positive…

ZaxbyHub/opencode-swarm · 91 tokens