gtskevin/readme-craft

readme-craft は何をしますか？

🚀 Codex/Claude Codeスキル：あらゆるGitHubリポジトリをプロフェッショナルでスターを集めるショーケースに変身させます。README、SVGアセット、バッジ、コミュニティファイルを自動生成します。

概要

このスキルは、AIエージェント（CodexまたはClaude Code）と連携して、GitHubリポジトリのドキュメント作成を自動化します。リポジトリの内容を分析し、以下のファイルを生成します：

• README.md：プロジェクトの説明、インストール手順、使用例などを含む構造化されたReadme
• SVGアセット：カスタムロゴやアイコンなどのSVG画像
• バッジ：ビルドステータス、ライセンス、バージョンなどを示すバッジ
• コミュニティファイル：CONTRIBUTING.md、CODE_OF_CONDUCT.md、SECURITY.mdなど

使い方

1. CodexまたはClaude Codeを起動します。
2. 以下のコマンドを実行します：

   /readme-craft <リポジトリパス>
   

3. スキルが自動的にリポジトリを解析し、関連ファイルを生成します。

オプション

• --output：出力ディレクトリを指定（デフォルト: カレントディレクトリ）
• --badges：特定のバッジのみを生成
• --svg：SVGアセットの生成をスキップ

例

# 基本的な使用法
/readme-craft .

# 特定の出力先を指定
/readme-craft /path/to/repo --output ./docs

# バッジのみ生成
/readme-craft . --badges

対応プラットフォーム

• Codex
• Claude Code

ライセンス

このスキルはMITライセンスの下で公開されています。

コントリビューション

バグ報告や機能リクエストはGitHubリポジトリで受け付けています。