New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Readme Blueprint Generator

by appleweiping in appleweiping/WEIPING_WIKI

Create, rewrite, or critique high-quality project README.md files.

MITAuto-check passedDevelopment

Install Readme Blueprint Generator

skills CLI
$ npx skills add appleweiping/WEIPING_WIKI --skill readme-blueprint-generator -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install appleweiping/WEIPING_WIKI readme-blueprint-generator --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/appleweiping/WEIPING_WIKI.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.codex/skills/readme-blueprint-generator .claude/skills/readme-blueprint-generator && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
readme-blueprint-generator
GitHub stars
119
Token cost
~880 tokens
SKILL.md length
403 words
Files
2
Skills in repo
51
Repo updated
First seen
Licence
MIT

At a glance

Create, rewrite, or critique high-quality project README.md files.

  • Works in 5 steps: Inspect the current README and the… → Decide the README's audience and job. → Build a narrative outline before editing. → …
  • The user asks to improve README aesthetics
  • SKILL.md covers Workflow, Recommended Structure, Quality Bar and Avoid
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Readme Blueprint Generator is an agent skill from appleweiping/WEIPING_WIKI. Create, rewrite, or critique high-quality project README.md files. Use when the user asks to improve README aesthetics, information architecture, onboarding quality, public GitHub presentation, maintainer quick-start docs, repository documentation polish, or a top-tier README rewrite. Also use when README changes must reflect AGENTS.md, project purpose, workflows, validation, installation, testing, contribution, security, or automation rules.

Its SKILL.md is about 880 tokens, which your agent loads only when the skill is triggered. The skill folder holds 1 other file.

It sits in Development, covering Technical documentation, UX design and Agent instruction files. It works with GitHub. The repository describes itself as: knowledge base managed with an LLM workflow. The licence is MIT.

When your agent uses it

  • The user asks to improve README aesthetics
  • Information architecture
  • Onboarding quality
  • Public GitHub presentation

Example prompts

  • “/readme-blueprint-generator”

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

  1. Inspect the current README and the project's authoritative docs before rewriting.
  2. Decide the README's audience and job.
  3. Build a narrative outline before editing.
  4. Rewrite for polish.
  5. Validate the README as an artifact.

What it can do on your machine

Read from SKILL.md and the folder at commit 76fdc42. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Readme Blueprint Generator loads about 880 tokens when it runs. Until then it costs about 118 tokens; SKILL.md has 403 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~118
When it runs · the whole SKILL.md, loaded when a task matches
~880

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from appleweiping/WEIPING_WIKI at commit 76fdc42, republished under its MIT licence (© appleweiping). 403 words, ~880 tokens.

Download SKILL.mdSave it as .claude/skills/readme-blueprint-generator/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
readme-blueprint-generator
description
Create, rewrite, or critique high-quality project README.md files. Use when the user asks to improve README aesthetics, information architecture, onboarding quality, public GitHub presentation, maintainer quick-start docs, repository documentation polish, or a top-tier README rewrite. Also use when README changes must reflect AGENTS.md, project purpose, workflows, validation, installation, testing, contribution, security, or automation rules.

README Blueprint Generator

Generate or rewrite README.md as the public front door to a repository. The output should feel intentionally designed: clear first impression, strong hierarchy, concrete quick start, and no filler.

Workflow

  1. Inspect the current README and the project's authoritative docs before rewriting.
    • Prefer AGENTS.md, .wiki-schema.md, purpose.md, CONTRIBUTING.md, WORKFLOWS.md, package metadata, docs indexes, and existing automation scripts when present.
    • If .github/copilot/ or .github/copilot-instructions.md exists, read the smallest relevant files for architecture, stack, tests, workflow, and standards.
  2. Decide the README's audience and job.
    • Public reader: what is this, why should they care, where do they go next?
    • Maintainer or future agent: how do they start, verify, maintain, and avoid dangerous mistakes?
  3. Build a narrative outline before editing.
    • Start with a crisp identity sentence.
    • Put the most important navigation and quick-start material above long reference sections.
    • Use tables only when they reduce cognitive load.
    • Link to deeper docs instead of duplicating them.
  4. Rewrite for polish.
    • Prefer specific verbs and nouns.
    • Remove generic "comprehensive", "powerful", "easy-to-use" language unless backed by concrete behavior.
    • Keep sections visually varied: short paragraphs, compact tables, short command blocks, and scannable bullets.
    • Avoid overlong catalogs in README; point to maintained indexes.
  5. Validate the README as an artifact.
    • Check that commands are plausible for the repo.
    • Check that public/private boundaries are respected.
    • Check that the README does not claim unverified features or live status.
    • Run the repository's documentation, lint, catalog, or diff hygiene commands when available.
Show full SKILL.md (161 more words)Show less

Use this only as a starting shape; adapt to the repo.

  • Title and one-sentence positioning.
  • Short "why it exists" paragraph.
  • Entry map or "start here" table.
  • Quick start or common commands.
  • Architecture or repository map.
  • Core workflows.
  • Quality gates and verification.
  • Contribution or maintenance contract.
  • Security/public-private boundaries when relevant.
  • Links to deeper docs.

Quality Bar

A strong README:

  • gives a first-time reader an accurate mental model in under one minute;
  • helps a future maintainer perform the next correct action without reading every file;
  • separates stable project truth from generated outputs, caches, and private material;
  • shows real commands, validation, and maintenance expectations;
  • has enough visual rhythm to be pleasant on GitHub without becoming decorative.

Avoid

  • Turning the README into a full wiki index.
  • Listing every file or every command.
  • Repeating complete operating docs that already live elsewhere.
  • Hiding important safety or validation rules below a wall of prose.
  • Adding badges, diagrams, or slogans that are not supported by the repository.

© appleweiping, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file in .codex/skills/readme-blueprint-generator of appleweiping/WEIPING_WIKI.

  • SKILL.md
  • LICENSE

Open the folder on GitHubat commit 76fdc42

Compare with similar skills

Readme Blueprint Generator next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Readme Blueprint Generator compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Readme Blueprint Generator this skillappleweiping/WEIPING_WIKI119—~880Automated safety check: PassMIT
Create Skill Samplepnp/copilot-prompts893—~3.1kAutomated safety check: PassMIT
Readme Blueprint Generatorgithub/awesome-copilot40k2 repos~729Automated safety check: PassMIT
Create Simple Promptpnp/copilot-prompts893—~2.6kAutomated safety check: PassMIT
Workflow Creatornicepkg/ai-workflow285—~2.6kAutomated safety check: PassMIT
Sync Agentthun-res/vlink116—~893Automated safety check: PassApache-2.0

Similar skills

  • Create Skill Sample

    pnp/copilot-prompts

    This skill should be used when the user asks to "create a new skill sample", "add a skill", "scaffold a new skill", "contribute a skill", "create a GitHub Copilot skill", "build a custom skill", or…

    893 GitHub stars~3.1k tokensUpdated 5 days ago
    DevelopmentAuto-check passed

  • Readme Blueprint Generator

    github/awesome-copilot

    Official

    Intelligent README.md generation prompt that analyzes project documentation structure and creates comprehensive repository documentation.

    40k GitHub starsUsed in 2 repos~729 tokens
    DevelopmentAuto-check passed

  • Create Simple Prompt

    pnp/copilot-prompts

    This skill should be used when the user asks to "create a new prompt sample", "add a new prompt sample", "scaffold a new prompt sample", "create a prompt contribution", "add a prompt", or needs to…

    893 GitHub stars~2.6k tokensUpdated 5 days ago
    AI & LLM EngineeringAuto-check passed

  • Workflow Creator

    nicepkg/ai-workflow

    Create complete Claude Code workflow directories with curated skills.

    285 GitHub stars~2.6k tokensUpdated 8 mo ago
    Agent WorkflowsAuto-check passed

  • Sync Agent

    thun-res/vlink

    基于 VLink 当前代码、doc、目录、工具和 GitHub 工作流事实,审计并同步 AGENTS.md、AI-POLICY.md、Copilot 指令、.agents 路由/索引/语言分册/ CI 说明、skill frontmatter、agents/openai.yaml 与 README 清单.用户 要求"同步 Agent 文件"、"根据代码更新 .agents"、"检查…

    116 GitHub stars~893 tokensUpdated 2 days ago
    Agent WorkflowsAuto-check passed

  • Export Template

    HurricaHjz/second-yourself

    Sync THIS LLM-Wiki framework with its public GitHub repo, ONE direction per run: --push (vault → repo) publishes your framework; --pull (repo → vault) updates your framework from a newer repo version.

    123 GitHub stars~4.8k tokensUpdated 9 days ago
    Knowledge ManagementAuto-check: warnings

More from appleweiping/WEIPING_WIKI

All 51 skills in this repo

  • Communication Assistant

    appleweiping/WEIPING_WIKI

    Unified lazy-mode communication assistant for Vipin across WhatsApp, WeChat, QQ, Feishu/Lark, and email.

    119 GitHub stars~1.1k tokensUpdated 1 mo ago
    Auto-check passed

  • Content Refinement Agent

    appleweiping/WEIPING_WIKI

    Step 5 of the PaperOrchestra pipeline (arXiv:2604.05018). An agent skill from appleweiping/WEIPING_WIKI.

    119 GitHub stars~3k tokensUpdated 1 mo ago
    Auto-check passed

  • Chrome Automation

    appleweiping/WEIPING_WIKI

    Connect to and control Google Chrome browser using agent-browser with CDP (Chrome DevTools Protocol).

    119 GitHub starsUsed in 1 repo~5.3k tokens
    Auto-check: warnings

  • Email Assistant

    appleweiping/WEIPING_WIKI

    Personal Gmail and Google Workspace email assistant for Vipin.

    119 GitHub stars~1.3k tokensUpdated 1 mo ago
    Auto-check passed

  • Wechat Video Channel Publish

    appleweiping/WEIPING_WIKI

    A skill your agent uses when the user wants to log into 微信视频号, validate cookie state, upload videos, set scheduled publish time, fill long description, set a cover image, or save drafts through a…

    119 GitHub stars~765 tokensUpdated 1 mo ago
    Auto-check passed

  • Feishu Bridge

    appleweiping/WEIPING_WIKI

    Route Feishu/Lark content access for Codex. An agent skill from appleweiping/WEIPING_WIKI.

    119 GitHub stars~906 tokensUpdated 1 mo ago
    Auto-check passed

Works with

Categories

Questions about Readme Blueprint Generator

What does Readme Blueprint Generator do?

Create, rewrite, or critique high-quality project README.md files. Readme Blueprint Generator is an agent skill from appleweiping/WEIPING_WIKI.md files.

When should I use Readme Blueprint Generator?

Readme Blueprint Generator fits situations like: the user asks to improve README aesthetics; information architecture; onboarding quality; public GitHub presentation.

How do I install Readme Blueprint Generator in Claude Code?

Run `npx skills add appleweiping/WEIPING_WIKI --skill readme-blueprint-generator -a claude-code`. Or copy the skill folder (.codex/skills/readme-blueprint-generator in appleweiping/WEIPING_WIKI) into .claude/skills/readme-blueprint-generator in your project. Claude Code loads it when a task matches its description.

How do I install Readme Blueprint Generator in Codex?

Run `npx skills add appleweiping/WEIPING_WIKI --skill readme-blueprint-generator -a codex`. Or copy the skill folder (.codex/skills/readme-blueprint-generator in appleweiping/WEIPING_WIKI) into .agents/skills/readme-blueprint-generator in your project. Codex loads it when a task matches its description.

Can I use Readme Blueprint Generator in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add appleweiping/WEIPING_WIKI --skill readme-blueprint-generator -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/readme-blueprint-generator, .gemini/skills/readme-blueprint-generator, .github/skills/readme-blueprint-generator and .opencode/skills/readme-blueprint-generator in your project.

What does Readme Blueprint Generator need to run?

SKILL.md names no scripts, command-line tools or credentials: Readme Blueprint Generator is instructions for the agent only.

Does Readme Blueprint Generator access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Readme Blueprint Generator safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Readme Blueprint Generator use?

Readme Blueprint Generator is published under the MIT licence (from the LICENSE file in the skill folder). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Readme Blueprint Generator use?

About 880 tokens (SKILL.md is roughly 3.5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Readme Blueprint Generator?

Skills that share tags, products or a category with Readme Blueprint Generator: Create Skill Sample (pnp/copilot-prompts, 893 stars), Readme Blueprint Generator (github/awesome-copilot, 40k stars), Create Simple Prompt (pnp/copilot-prompts, 893 stars) and Workflow Creator (nicepkg/ai-workflow, 285 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Readme Blueprint Generator?

appleweiping (a GitHub user) maintains it in appleweiping/WEIPING_WIKI, which has 119 GitHub stars. The repository holds 51 skills in this directory. The repository was last updated on August 26, 2026.

Source: appleweiping/WEIPING_WIKI on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.