Day 24 如何撰寫 README.md

README.md 是開源專案的重要文件之一，每個人看到專案的第一眼就會是它，它可以幫助人們了解專案的目的、功能、如何使用、如何貢獻等內容。因此，寫出吸引人的 README.md 是一件非常重要的事。

模仿知名專案的 README.md

首先，筆者會先去找一些知名的開源專案，然後嘗試參考並模仿它們的 README.md。

清晰的標題和介紹

在 README.md 一開始要簡單介紹這個專案的目的和功能，讓人們快速了解專案的用途。

Badges

在專案的 README.md 上面，最吸引人的通常就是各式各樣的 Badges，同時這些 Badges 也可以讓人快速了解專案的狀態，例如：CI 狀態、測試覆蓋率、版本號、下載次數等等，這可以提高專案的專業形象。除此之外通常也會幫 Badge 加上超連結，如果使用這個 SDK 的開發者對 badge 顯示的資訊有興趣的話，就可以點連結查看更詳細的資料。

通常大家都是透過 https://shields.io/ 這個網站產生的，這個網站產生的 Badges 也很好看，除了可以自訂顏色之外，還可以自訂圖示，你也可以去看看有什麼喜歡的 Badge 然後加到專案的 README.md 內喔。

網路上還有人整理一堆 Badges 可以參考 https://github.com/alexandresanlim/Badges4-README.md-Profile

安裝和使用指南

在專案的 README.md 上面，通常會有安裝和使用指南，讓人們可以快速安裝和使用專案。筆者在這部份寫上了如何使用套件管理程式來安裝、如何使用 commonjs 及 ESM 兩種方式來引用這個 SDK，以及在瀏覽器上面要如何使用這個 SDK。

快速上手的程式碼範例

在專案的 README.md 上面，通常會有快速上手的程式碼範例，讓人們可以快速試用這個 SDK。

參考連結

• 為你的開源專案加些文件 讓它看起來很專業吧
• LINE 開發社群計畫: 「手把手教你建立自己的開源專案」
• Badges4-README.md-Profile