create-readme

create-readme is a skill for Claude Code from tuliosousapro/SaaS-blueprint. It costs 53 tokens per session (622 once invoked), scanned A, original, MIT.

A prompt for creating a README.md file, the main guide to a software repository, from the project's existing documentation. It covers the project purpose, technology, architecture, setup, and usage.

In plain words
What is it for?
Use it when creating a new repository or when a project is missing a README.md file.
Why use it?
New repositories or projects without a README are harder for developers to understand and start using. This gathers information from the available project documents into one guide.

Skill for Claude Code

Written for Claude Code: shipped in a Claude Code plugin.

Part of the SaaS-blueprint plugin — 14 skills shipped together

Good fit Use it when creating a new repository or when a project is missing a README.md file.

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

Made for: Claude Code.

Or install SaaS-blueprint, the plugin that ships this one along with the rest of its 14 skills.

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

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

Your own site · 80×15
<a href="https://agentmods.dev/skills/tuliosousapro/saas-blueprint/create-readme"><img src="https://agentmods.dev/badge/skills/tuliosousapro/saas-blueprint/create-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 53 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 622 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.00053 $0.00622
Opus 5 $0.00026 $0.00311
Sonnet 5 $0.00011 $0.00124
Haiku 4.5 $0.00005 $0.00062

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

Security

Grade A, and why

create-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 9d 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/create-readme/SKILL.md · 96 lines

How it starts

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

Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

Task

Analyze the documentation files in the ./ directory. Follow these steps:

  1. Scan all the files in the ./ directory, like:

    • Architecture
    • Code_Exemplars
    • Coding_Standards
    • Project_Folder_Structure
    • Technology_Stack
    • Unit_Tests
    • Workflow_Analysis
  2. Create a README.md with the following sections:

Project Name and Description

  • Extract the project name and primary purpose from the documentation
  • Include a concise description of what the project does

Technology Stack

  • List the primary technologies, languages, and frameworks used
  • Include version information when available
  • Source this information primarily from the Technology_Stack file

Project Architecture

  • Provide a high-level overview of the architecture
  • Consider including a simple diagram if described in the documentation
  • Source from the Architecture file

Getting Started

  • Include installation instructions based on the technology stack
  • Add setup and configuration steps
  • Include any prerequisites

Project Structure

  • Brief overview of the folder organization
  • Source from Project_Folder_Structure file

Key Features

  • List main functionality and features of the project
  • Extract from various documentation files

Development Workflow

  • Summarize the development process
  • Include information about branching strategy if available
  • Source from Workflow_Analysis file

Coding Standards

  • Summarize key coding standards and conventions
  • Source from the Coding_Standards file

Testing

  • Explain testing approach and tools
  • Source from Unit_Tests file

Contributing

  • Guidelines for contributing to the project
  • Reference any code exemplars for guidance
  • Source from Code_Exemplars and copilot-instructions

License

  • Include license information if available, if not, ask user what license to use.

Read the full file on GitHub · 96 lines

Files

What ships with it

4 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. 9d ago First seen · 96 lines · 53 tokens per session scan A aa06e95a6570

Subscribe to this mod's changes

create-readme is a skill published in the GitHub repository tuliosousapro/SaaS-blueprint (4 stars, last pushed 8d ago), licensed MIT. It adds 53 tokens to every session and 622 once invoked, about $0.0003 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-31.

Related

Other skills, from other repositories

ship-it-or-fix-it

Oracle-frozen Builder and independent-Judge convergence cycle. Load ONLY when the operator explicitly sets Governance Dial G2 for the task, or explicitly names this skill or an active work unit already running it. Never auto-activate on task class, such as security, auth, or payments. If a task seems to warrant G2 and…

Ezra144israel/governed-agent-skills · 98 tokens

test-verification

Requires behavioral, failure-path, and durable-seam evidence for tests and review. Use when writing tests, reviewing test coverage, assessing behavioral test quality, or accepting high-risk behavior on test evidence.

Ezra144israel/governed-agent-skills · 43 tokens

portable-adaptive-planning

Use for planning, roadmaps, design, architecture, sequencing, or before consequential work when no current FINAL plan plus GO covers it. Fire before changes to data or schemas, credentials or auth, production or releases, repository or source-home boundaries, irreversible work, or materially costly mistakes. Re-enter…

Ezra144israel/governed-agent-skills · 107 tokens

reasoning-doctrine

The working method for every nontrivial task: frame the objective, ground load-bearing facts, converge on a route, execute without drift, and verify before delivery. Use for analysis, planning, implementation, debugging, document work, reviews, and multi-stage tasks.

Ezra144israel/governed-agent-skills · 58 tokens

write-maintainable-code

Evaluate minimum-sufficient implementation routes and enforce the selected route for a fixed, authorized outcome. Use after outcome, scope, authority, and acceptance evidence are fixed. Do not choose outcomes, set acceptance, adjudicate governance, grade finished work, design tests alone, conduct security audits, or…

Ezra144israel/governed-agent-skills · 67 tokens

governed-operator

Full governance constitution for work that touches shared state, requires independent review, spans seats, or involves planning, architecture, code, reviews, dispatches, status reports, or canonical records. Not needed for quick factual questions or trivial one-off answers.

Ezra144israel/governed-agent-skills · 55 tokens