⭐️が100以上のREADME.mdは何を書いているんだ？？ 〜個人開発のリポジトリを除いてみた〜
Tokeru(macOSアプリ)を開発しているimajoです。
TokeruはPublicなリポジトリとして開発をしていますが、最近はREADMEをどう書いたら興味を持ってもらえるのだろうかと悩み夜しか眠れません。🥱
そこでPublicな個人開発はどんなREADMEをどのように書いているのか調べてみることにしました。
スターが100以上ついているリポジトリを見つけ出してREADMEを眺めてみましたので記事として書き残しておこうと思います。
(その前に開発しているTokeruのリポジトリをポチッと貼らせてください🙇)
Ice
まずはIceというmacのmenu barをカスタマイズできるアプリを見てみたいと思います。
| key | value |
|---|---|
| スター数 | 639(2024/4/6) |
| 開発者 | jordanbaird |
| Contributor数 | 2人 |
アプリ名とアイコン
1番最初に目に入ってくるのはアプリアイコンとアプリ名です。
プロダクトの色を初めに認識してもらうことで、閲覧者の記憶に残るようになっています。
説明とスクリーンショット
次に出てくるのはプロダクトの簡単な説明と、スクリーンショットです。
翻訳すると以下のようになります。
Ice は強力なメニュー バー管理ツールです。その主な機能はメニュー バー項目の表示と非表示ですが、さまざまな追加機能をカバーして、利用可能な最も多用途なメニュー バー ツールの 1 つにすることを目指しています。
バッジ
次はバッジがいくつか記載されています。
個人的にはここに載っている情報は見逃されやすい気がするので、他にもしっかり記載したほうがいい気がしていますが、
なんとなくイケてる気がするので、真似してみたくなります。
Note
その下にはNoteとしてこんなことが書かれています。
Iceはベータ版であり、これからアップグレードがされていくことが伝わります。
個人開発に限りませんが、プロダクトは完成してから出すのでは遅いと私は考えています。
しかし、中途半端な状態で出して全然使えねぇじゃん！って思われるのも嫌なのがエンジニアです。ちゃんと開発途中であることは書いておくのが安心です。
Ice は現在鋭意開発中です。一部の機能はまだ実装されていません。ここから最新リリースをダウンロードし、今後の機能については以下のロードマップを参照してください。
インストール方法
次はインストール方法です。
Iceはzipファイルのダウンロードだけではなくbrewでインストールできるみたいです。
機能・ロードマップ
これは面白い！と思ったのが、ロードマップをREADMEにチェックリストとして作っていることです。
単純にどんな機能があるのかを伝えるだけではなく、今後何を予定しているかまで見ることができます。
IssueやDiscussionを使って開発中の機能を知ってもらうこともできますが、全員がREADME以外のページを見るとは限りません(むしろ見るほうが少数な気がする)
READMEに書かれていると閲覧者をワクワクさせることができそうです。
スポンサー
IceはGitHubのスポンサー機能を通じてユーザーからお金を集めているみたいです。
その説明が書かれています。
個人的には個人開発を続けるモチベーションの1つとしてお金は大事な要素だと思います。
Ice を無料で利用できるようにすることにしました。価値があると感じていただけましたら、今後の開発を継続できるようスポンサーになることをご検討ください。金額に関わらず大歓迎です。
名前の由来
Iceという名前の由来が書かれています。
名前の由来を知ると愛着が湧いてきたりする気がします。
メニュー バーが氷のようになり、メニュー バーの項目が滑り落ちてしまうからです 🧊🧊🧊
ギャラリー
一番最初のスクリーンショットでは伝えきれないユースケースが書かれています。
ライセンス
最後はライセンスについて書かれています。
MeetingBar
次もmacOSアプリのMeetingBarを除いていこうと思います。
| key | value |
|---|---|
| スター数 | 4.2k(2024/4/6) |
| 開発者 | Andrii Leitsius |
| Contributor数 | 91人 |
バッジ
MeetingBarでは一番最初にバッジを持ってきています。
Iceは3番目くらいでしたが、上の方に持ってくる人が多いようです。
概要・スクリーンショット
Ice同様にアプリの簡単な説明とスクリーンショットがあります。
やはり、プロダクトに興味を持ってもらうにはなるべく短い説明と、どんなプロダクトか視覚的にわかる画像があるのが良さそうです。
MeetingBar は、カレンダー会議用のメニューバー アプリです (macOS 10.15 以降)。
50 以上の会議サービスと統合されているため、イベントから会議にすばやく参加したり、アドホック会議を作成したりできます。
Link
プロダクトハントやApp Store、buy me a coffee(開発者にお金を渡せるサービス)のリンクがあります。
しかしただのリンクではなく、ボタンになっているので目に入りやすくなっています。
機能
使える機能が箇条書きで記されています。
ぱっと見量が多くて閲覧者はじっくり読まない気がします。
ここに関してはIceの方が読みやすく、開発中の機能もわかるので分がある気がします。
セットアップ
環境構築について書かれています。
Supported meeting services
MeetingBarはプロダクトの性質上他のサービスとの連携が必須ですが、対応しているサービスが書かれています。
MeetingBar は、Google Meet、Zoom、Microsoft Teams、GoToMeeting、Skype、WebEx、Discord など 50 以上のサービスをサポートしています。完全なリストをご覧ください。
Third-Party Integrations
サードパーティーとの連携について書かれています。ここではRaycastのみです。
類似サービス
なんでこんなことをしているのか全然わからないのですが、似ているサービスを紹介しています。
自分のサービスを使ってもらいたいはずなので、紹介するメリットが思いつかないのですが、とりあえず書かれています。
メリットがわかる方は是非コメントで教えてください。
Contribute
もしこのプロジェクトに貢献する人がいたときのために、CONTRIBUTE.mdを用意しています。
Support the project
MeetingBarもまたサポートする方法を載せています。
こちらはPatreonを通じて受け付けています。
Credits
Contributors
開発に貢献している人を載せています。
コントリビューター自体はもっといるはずなので、メインの開発者でしょうか。
作っている人を知ってもらうのは開発していて一番嬉しい瞬間ではないでしょうか。
結局どんなことを書けば良いのか
2つのREADMEを見てみて、似たようなことを書いている部分、独特なことを書いている部分がありました。
結局自分のプロジェクトには何を書けばいいのでしょうか?
私が開発しているTokeruで試してみました。
(必須)アプリアイコンと名前
まずはアプリアイコンと名前です。
プロダクトを印象付けるために一番最初に持ってきました。
(オプショナル)バッジ
まだ少ないのですが、バッジを記載してみました。
必須ではないですが、この数が増えてくるとテンションも上がってきます。
最初は少なくていいので追加してみましょう。
(必須)プロダクトの簡単な説明とスクリーンショット
プロダクトを手短に知ってもらうには必須の項目です。
説明はできるだけ簡素にし、スクリーンショットは使うイメージが湧きやすいものにしましょう。
(必須)インストール方法
インストール方法は必須ですが、TokeruはまだBeta版です。
開発中でいろんな機能がこれから追加されることを伝えています。
機能
リリースされている機能を伝えましょう。
Iceで行われていたチェックリスト方式を採用しました。
(オプショナル)環境構築
Tokeruではまだ用意していないのですが、多くの個人開発プロジェクトはコントリビューターがいます。
貢献したいと思ってくれた人のために環境構築を用意しておく方が優しさ全開です。
(必須)サポート
私もBuy me a Coffeeをしているので、サポートを受けてみました！
個人開発とはいえ、お金を稼ぐことは悪いことではなく、モチベーションや運営のためにも必要なことです。
なので必須項目として書いてみました。
(必須)Contributor
Tokeruは自分以外に少し手伝ってくれている友人がいます。
そのメンバーのためにもContributorとして紹介しましょう。
最後に
調べてみるといろんな個人開発がありますが、READMEがしっかり書かれているだけで使ってみたいと思わせてくれます。
そのためにもしっかり書いて素晴らしい個人開発ライフを送りましょう！！
その他参考になりそうな個人開発のリポジトリ
(...現在募集中です。紹介して欲しいいリポジトリがあれば、zennのコメントにお待ちしております！😀)
Discussion
あと競合だったり類似アプリが列挙されてると助かったりしますね。
ユーザー側の理解が早くなったり、選ぶときの参考になったりするからとても重宝してます。