Skip to content

docs: optimize README for GitHub star conversion#365

Merged
Kewton merged 1 commit intomainfrom
docs/readme-optimization-for-stars
Feb 24, 2026
Merged

docs: optimize README for GitHub star conversion#365
Kewton merged 1 commit intomainfrom
docs/readme-optimization-for-stars

Conversation

@Kewton
Copy link
Owner

@Kewton Kewton commented Feb 24, 2026

Summary

  • Quick Start を above the fold に移動: npx commandmate をタグライン直後に配置。訪問者がスクロールせずに「1コマンドで試せる」と分かるように
  • Star CTA バッジ追加: バッジ行の先頭に GitHub Stars バッジを追加し、Star アクションを自然に促進
  • ナラティブ短縮: 6文 → 3文に凝縮。離脱率を下げつつメッセージを維持
  • Use Cases セクション追加: Workflow(手順書的)→ Use Cases(共感ベース)に置換。ソファ開発・通勤レビュー・夜間実行など具体シナリオ
  • Screenshots 展開表示: <details> 内に隠れていたスクリーンショットを直接表示(スクリーンショット付き README は +42% Star というリサーチに基づく)
  • トンネリングサービス追加: Security セクション・FAQ に Cloudflare Tunnel / ngrok / Pinggy の3サービスを記載
  • 日本語 README も同一構造で更新

Background

GitHub README のベストプラクティス調査(Liam の 0→3000 Star ケーススタディ等)に基づき、Star 獲得に直結する S/A ランク改善を実施。

Test plan

  • GitHub 上で README のレンダリングを確認(EN/JA 両方)
  • バッジが正しく表示されるか確認
  • スクリーンショット画像が正しく表示されるか確認
  • Mermaid 図が正しくレンダリングされるか確認
  • 各リンク(docs, security guide 等)が正しく動作するか確認
  • モバイルブラウザでの表示確認

🤖 Generated with Claude Code

- Move Quick Start (`npx commandmate`) above the fold for immediate visibility
- Add GitHub Stars badge as call-to-action
- Condense narrative from 6 sentences to 3 for better readability
- Replace Workflow section with Use Cases (couch, commute, overnight, etc.)
- Expand Screenshots section (no longer hidden in <details>)
- Add tunneling options (Cloudflare Tunnel, ngrok, Pinggy) to Security and FAQ
- Move detailed Quick Start to collapsible section to reduce main content length
- Apply same changes to Japanese README (docs/ja/README.md)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@Kewton Kewton merged commit e71b0d5 into main Feb 24, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant