Skip to content
Back to search

readme-skill

SkillWorks with Claude CodeGitHub

GitHub リポジトリの README を、有名リポジトリのような見た目(中央寄せの言語切替とタイトル、色分けしたバッジ、Alert、折りたたみの表、英日の2言語)に作る・作り直すスキル。「READMEを作って」「READMEを良くして」「READMEをかっこよく」「バッジを付けて」と頼まれたときに使う。バナーは、見栄えよく作れるときと、指定があるときだけ付ける。

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/lapius7--readme-skill/badge.svg)](/listings/lapius7--readme-skill)

HTML

<a href="/listings/lapius7--readme-skill"><img src="/api/listings/lapius7--readme-skill/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Put the folder where Claude Code looks for skills.

git clone https://github.com/Lapius7/readme-skill ~/.claude/skills/readme-skill

The banner script needs [uv](https://docs.astral.sh/uv/) and Pillow, which `uv run` fetches on demand.

> [!NOTE] > The skill refers to the `yomiyasu` skill for Japanese proofreading. It still works without it, but the Japanese text is not proofread.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

SKILL.md · Manifest · 89 lines
  1. ---
  2. name: readme-skill
  3. description: GitHub リポジトリの README を、有名リポジトリのような見た目(中央寄せの言語切替とタイトル、色分けしたバッジ、Alert、折りたたみの表、英日の2言語)に作る・作り直すスキル。「READMEを作って」「READMEを良くして」「READMEをかっこよく」「バッジを付けて」と頼まれたときに使う。バナーは、見栄えよく作れるときと、指定があるときだけ付ける。
  4. ---
  5. # README Creator SKILL
  6. README を、見た目と中身の両方で整えます。見た目の基準は Firecrawl や Disc Image Studio のような有名リポジトリです。ただし、見た目より事実の正しさを優先します。
  7. ## 手順
  8. 1. **事実を集める**: コード、package.json、既存の README、設定ファイルを読み、機能名、ツール名、上限値、必要なもの、ライセンスを確かめる。確認できないことは書かない。
  9. 2. **構成を決める**: 下の「構成」に沿って章を並べる。
  10. 3. **バナーを作る(任意)**: 暗い画面イメージや罫線の図柄などの元画像に大きなタイトルを重ねて、見栄えよく作れるときは付ける。ユーザーに指定があるときも付ける。コマンドやコードの文字を並べただけの画像(ターミナル画面の画像化、コード断片の背景)、文字だけ、単色の板になるときは付けない。迷うときも付けない。下の「バナー」に従う。
  11. 4. **README を書く**: `templates/README.template.md` を元にする。英語版を `README.md`、日本語版を `README.ja.md` に置き、構成をそろえる。
  12. 5. **推敲する**: 日本語は skill `yomiyasu` で推敲する。英語は文法と、削れる語を点検する。
  13. 6. **確かめる**: バッジの URL(バナーがある場合はバナーの URL も)が 200 を返すこと、リンク切れがないことを確認する。GitHub 上の表示を見られないときは、見ていないと報告する。
  14. ## 構成
  15. 上から順に、次の章を並べます。
  16. 1. 言語切替(`English | 日本語`、中央寄せ)と、その下のタイトル(`<h1>`)。バナーを付ける場合は、言語切替の上に置く(角丸、幅いっぱい)
  17. 3. キャッチコピー(太字の1文)と、短い説明(1〜2文)
  18. 4. バッジ行
  19. 5. 目次リンク(Quick start · Tools · Safety · Roadmap)
  20. 6. 概要: 何ができるか、頼み方の例
  21. 7. 特長: 箇条書き
  22. 8. Quick start: 必要なもの、インストール、設定、試し方
  23. 9. ツール/機能: 長い表は `<details>` に入れて、冒頭を短くする
  24. 10. 設定
  25. 11. 安全のために: WARNING や CAUTION の Alert
  26. 12. 開発
  27. 13. 今後の予定(実装済みの項目は載せない)
  28. 14. ライセンス
  29. ## バナー(任意)
  30. 付けてよい: 画面や UI の図柄(罫線のグリッド、ワイヤーフレーム、実際の画面)を暗くして、大きなタイトルを重ねたもの(基準は dark-landing-skill のバナー)。
  31. 付けない: コマンドやコードの文字を並べただけの画像(ターミナル画面の画像化、コード断片の背景)。文字だけ、単色の板、図柄が貧弱で見栄えのしないものも付けない。
  32. 迷うときは付けない。
  33. - 2400×800 前後。角丸にして、プロジェクト名を大きな白字で重ねる。文字には控えめな影を付ける。
  34. - 元になる画像は、そのプロジェクトの成果物の画像を使う。成果物が見た目のあるものなら、実物のレンダリングやスクリーンショットにする。
  35. - 安いグラデーション、発光、汎用の立方体アイコン、意味のない抽象図形は使わない。AI が作った汎用画像に見えるため。
  36. - `scripts/make-banner.py` が、元画像の暗転、角丸、文字の重ねを行う。使い方: `uv run --with pillow python <スキルのパス>/scripts/make-banner.py "プロジェクト名" [元画像] [出力]`(既定は `docs/images/hero.png` から `docs/images/banner.png`)。
  37. ## バッジ
  38. shields.io の `style=flat-square` で統一し、バッジごとに固有の色とロゴを付ける。単色にそろえない。
  39. | バッジ | 色の目安 |
  40. |---|---|
  41. | release | オレンジ `e8833a`、logo=github |
  42. | CI | 既定の緑、logo=githubactions |
  43. | license | 黄緑 `97ca00` |
  44. | Bun | 薄い黄 `fbf0df`、logoColor=000000 |
  45. | MCP | 紫 |
  46. | Minecraft など対象 | 対象の色(Minecraft は緑 `62b47a`) |
  47. | stars | 金 `e3b341` |
  48. | last commit | 青 |
  49. - 実在するリンクだけを付ける。X や Discord のように、持っていないものを置かない。
  50. - ロゴは simple-icons にあるものだけ付ける。
  51. - すべて `<a>` で包み、正しいリンク先を付ける。
  52. ## Alert
  53. GitHub の Alert 記法で、意味のある所にだけ色を付ける。
  54. | 種類 | 使う場面 |
  55. |---|---|
  56. | `> [!NOTE]` | 補足、未検証の範囲、仕様の限界 |
  57. | `> [!TIP]` | 便利な使い方 |
  58. | `> [!IMPORTANT]` | 挙動の変更、必須の設定 |
  59. | `> [!WARNING]` | 危険な操作、暗号化されない通信 |
  60. | `> [!CAUTION]` | データの消失など、取り返しのつかないこと |
  61. 絵文字は使わない。Alert を多用せず、1節に1〜2個までにする。
  62. ## 守ること
  63. - **タイトルはリポジトリ名にしない**: `<h1>` とバナーの文字には、人が読む自然な表示名を使う(`readme-skill` → `README Creator SKILL`、`mcp-minecraft-controller` → `Minecraft Controller MCP`)。英語は単語の頭を大文字にし、ハイフンを外す。日本語版も同じ表示名にする。リポジトリ名は、URL、clone のパス、バッジの URL にだけ使う。バナー生成時の引数にも表示名を渡す。
  64. - **事実を優先する**: ツール名、上限値、設定名は、コードと照合する。実機で試していないことは、未検証と書く。
  65. - **比喩や宣伝文句を避ける**: 「革命的」「究極の」などの語を使わない。結論から書く。
  66. - **英日で同じ構成にする**: 片方だけに章や表を足さない。
  67. - **小さな変更は PR にしない**: README の修正は、利用者の許可があれば main へ直接コミットしてよい。
  68. - **AI の名前を入れない**: コミットメッセージにも、README にも、Claude や Co-Authored-By を書かない。
  69. - **改名したときは**: README の URL、clone のパス、バッジの URL をすべて直す。
README.md · README · 84 lines
  1. <div align="center">
  2. <p align="center"><img alt="readme-skill: a sample README rendered in GitHub dark theme" src="docs/images/banner.png" width="100%"></p>
  3. <p align="center"><b>English</b> | <a href="README.ja.md">日本語</a></p>
  4. <h1 align="center">README Creator SKILL</h1>
  5. <h3 align="center">A Claude skill that writes READMEs that look like the well-known repositories.</h3>
  6. <p align="center">Centered banner, colored badges, GitHub Alerts, collapsible tables, and matching English and Japanese versions. Facts first, decoration second.</p>
  7. <p align="center">
  8. <a href="https://github.com/Lapius7/readme-skill/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/Lapius7/readme-skill?style=flat-square&color=e3b341&logo=github"></a>
  9. <a href="https://github.com/Lapius7/readme-skill/commits/main"><img alt="Last commit" src="https://img.shields.io/github/last-commit/Lapius7/readme-skill?style=flat-square&color=3b82f6"></a>
  10. <a href="https://docs.claude.com/en/docs/claude-code/skills"><img alt="Claude skill" src="https://img.shields.io/badge/Claude-skill-d97757?style=flat-square&logo=anthropic&logoColor=white"></a>
  11. <a href="https://github.com/python-pillow/Pillow"><img alt="Pillow" src="https://img.shields.io/badge/banner-Pillow-3776ab?style=flat-square&logo=python&logoColor=white"></a>
  12. </p>
  13. <p align="center">
  14. <a href="#what-it-does">What it does</a> ·
  15. <a href="#install">Install</a> ·
  16. <a href="#usage">Usage</a> ·
  17. <a href="#whats-inside">What's inside</a>
  18. </p>
  19. </div>
  20. ---
  21. Ask Claude for "a better README" or "a README with badges and a banner", and this skill sets the structure, the badges, the alerts, and the banner, then checks the result.
  22. ## What it does
  23. - **Structure**: language switch, banner, tagline, badges, overview, features, quick start, tools, configuration, safety, development, roadmap, license, in that order.
  24. - **Banner**: a rounded wide image with the project name in large white text, made from a real render or screenshot of the project. `scripts/make-banner.py` does the darkening, rounding, and lettering.
  25. - **Badges**: shields.io `flat-square`, one color and one logo per badge. Only links that exist.
  26. - **Alerts**: `NOTE`, `TIP`, `IMPORTANT`, `WARNING`, `CAUTION`, used where they mean something, with no emoji.
  27. - **English and Japanese**: both versions share one structure. Japanese is proofread with the `yomiyasu` skill.
  28. - **Facts first**: tool names, limits, and settings are checked against the code. What was not tried on a real setup is marked as unverified.
  29. ## Install
  30. Put the folder where Claude Code looks for skills.
  31. ```sh
  32. git clone https://github.com/Lapius7/readme-skill ~/.claude/skills/readme-skill
  33. ```
  34. The banner script needs [uv](https://docs.astral.sh/uv/) and Pillow, which `uv run` fetches on demand.
  35. > [!NOTE]
  36. > The skill refers to the `yomiyasu` skill for Japanese proofreading. It still works without it, but the Japanese text is not proofread.
  37. ## Usage
  38. Ask in plain words. Examples:
  39. - "Write a README for this repository."
  40. - "Make the README look better, with badges and a banner."
  41. - "Rename done. Fix the URLs in the README."
  42. To make only the banner:
  43. ```sh
  44. uv run --with pillow python scripts/make-banner.py "Project Name" docs/images/hero.png docs/images/banner.png
  45. ```
  46. The source image defaults to `docs/images/hero.png`, and the output to `docs/images/banner.png`, relative to the directory you run it in.
  47. ## What's inside
  48. | Path | Purpose |
  49. |---|---|
  50. | `SKILL.md` | The instructions Claude follows: steps, structure, banner, badges, alerts, rules. |
  51. | `templates/README.template.md` | A starting README with the centered header, badge row, alerts, and collapsible table. |
  52. | `scripts/make-banner.py` | Makes the rounded banner with the project name. |
  53. > [!IMPORTANT]
  54. > Keep the English and Japanese READMEs in the same structure. Add a section to one, and add it to the other.
  55. ## License
  56. MIT. See [LICENSE](LICENSE). The bundled `scripts/vendor` CSS is github-markdown-css (MIT, Sindre Sorhus).

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.