メニュー
README.md with logo, badges, features, tech stack sections. Use when creating a README, auditing missing sections, or adding shields.io badges.
デフォルトでは、最初にソースを確認する Prompt が選択されています。直接コマンドに切り替えるか、ローカルコピーをダウンロードすることもできます。
インストールを決める前に、SKILL.md と SkillsMP に表示されている付属ファイルをお読みください。
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
直接コマンドでは確認用 Prompt が省略されます。実行前にソースを確認してください。
npx skills add https://github.com/laurigates/claude-plugins --skill configure-readmeコマンドは1行のまま表示されます。コピー前に横へスクロールして全体を確認してください。
ローカルで確認しますか？SkillsMP が現在取得できるファイルをダウンロードできます。
Install, configure and troubleshoot MCP servers. Use when adding/enabling servers, editing .mcp.json, fixing OAuth, or when a server runs stale code after an upstream fix.
FinOps snapshot — org billing, workflow stats, cache usage. Use when you want a high-level view of CI spending or workflow health before diving deeper.
GitHub Actions billing, workflow efficiency, and waste analysis at org or repo level. Use when investigating CI/CD costs, wasted runs, or optimizing triggers.
SKILL.md を表示中
SOC 職業分類に基づく
| created | "2025-12-17T00:00:00.000Z" |
| modified | "2026-07-05T00:00:00.000Z" |
| reviewed | "2026-02-08T00:00:00.000Z" |
| description | README.md with logo, badges, features, tech stack sections. Use when creating a README, auditing missing sections, or adding shields.io badges. |
| allowed-tools | Glob, Grep, Read, Write, Edit, Bash, AskUserQuestion, TodoWrite, WebSearch |
| args | [--check-only] [--fix] [--style <minimal|standard|detailed>] [--badges <shields|custom>] |
| argument-hint | [--check-only] [--fix] [--style <minimal|standard|detailed>] [--badges <shields|custom>] |
| name | configure-readme |
| Use this skill when... | Use another approach when... |
|---|---|
| Creating a README.md for a new project from scratch | Editing specific README content — use direct file editing |
| Auditing an existing README for missing sections (badges, install, structure) | Writing detailed API documentation — use /configure:docs |
| Standardizing README format across multiple projects | Creating GitHub Pages documentation site — use /configure:github-pages |
| Adding shields.io badges, tech stack table, or project structure section | Writing a changelog — use release-please automation via conventional commits |
| Ensuring README includes correct install/build/test commands for the detected stack | Only need to update a single section — edit the file directly |
pwdbasename $(pwd)find . -maxdepth 1 -name 'README.md'find . -maxdepth 1 \( -name 'package.json' -o -name 'pyproject.toml' -o -name 'Cargo.toml' -o -name 'go.mod' \)git remote -vfind . -maxdepth 1 -name 'LICENSE*'find . -maxdepth 2 -type d \( -name 'assets' -o -name 'public' -o -name 'images' \)find . -maxdepth 3 -type f \( -name 'logo*' -o -name 'icon*' \)Parse from command arguments:
--check-only: Report README compliance status without modifications (CI/CD mode)--fix: Apply fixes automatically without prompting--style <minimal|standard|detailed>: README detail level (default: standard)--badges <shields|custom>: Badge style preference (default: shields)--no-logo: Skip logo section even if assets existStyle Levels:
minimal: Title, description, badges, basic install/usagestandard: Logo, badges, features, tech stack, getting started, license (recommended)detailed: All of standard plus: architecture diagram, API reference, contributing guide, changelog linkExecute this README configuration workflow:
Read project metadata from the detected package files:
Fallback detection when no package file matches:
For detailed package file format examples, see REFERENCE.md.
Check existing README.md for these sections:
Discover logo/icon assets in common locations:
assets/logo.png, assets/icon.png, assets/logo.svgpublic/logo.png, public/icon.svgimages/logo.png, docs/assets/logo.png.github/logo.png, .github/images/logo.pngPrint a section-by-section compliance report showing PASS/MISSING/PARTIAL status for each README section. Include content quality checks (code examples, command correctness, link validity).
If --check-only is set, stop here.
For the compliance report format, see REFERENCE.md.
Generate README.md following the standard template structure:
--no-logo not set)For the full README template and badge URL patterns, see REFERENCE.md.
If no logo exists but user wants one:
mkdir -p assetsAuto-detect project commands based on package manager/build tool:
| Package Manager | Install | Run | Test | Build |
|---|---|---|---|---|
| npm/bun (package.json) | Read scripts from package.json | npm run dev | npm test | npm run build |
| uv/poetry (pyproject.toml) | uv sync / poetry install | uv run python -m pkg | uv run pytest | - |
| cargo (Cargo.toml) | cargo build | cargo run | cargo test | cargo build --release |
| go (go.mod) | go build | go run . | go test ./... | go build |
Run tree -L 2 -I 'node_modules|target|__pycache__|.git|dist|build' --dirsfirst to generate accurate project structure. Skip common generated directories (node_modules, vendor, target, dist, build, pycache, .pytest_cache, .git, .venv, venv).
Update .project-standards.yaml:
components:
readme: "2025.1"
readme_style: "[minimal|standard|detailed]"
readme_has_logo: true|false
readme_badges: ["license", "stars", "ci", "version"]
After generating README, validate:
Print a summary of changes made, the README location, and recommended next steps (customize feature descriptions, add logo, run other configure commands).
For the results report format, see REFERENCE.md.
When --style detailed is specified, also include architecture section with mermaid diagram, API reference link, and changelog link. For detailed style templates, see REFERENCE.md.
Provide:
| Context | Command |
|---|---|
| Quick compliance check | /configure:readme --check-only |
| Auto-fix all issues | /configure:readme --fix |
| Minimal README | /configure:readme --fix --style minimal |
| Full detailed README | /configure:readme --fix --style detailed |
| Generate project tree | tree -L 2 -I 'node_modules|target|__pycache__|.git|dist|build' --dirsfirst |
| Check README exists | test -f README.md && echo "EXISTS" || echo "MISSING" |
/configure:docs - Configure code documentation standards/configure:github-pages - Set up documentation hosting/configure:all - Run all compliance checks