README 是模組的門面，能不能吸引要別人使用你的模組，就看這一頁了。

slogan

通常第一行都是口號 (slogan)，用一句最吸睛的話，來介紹你的模組。

badges

口號後面通常接著徽章 (badges)，讓使用者可以一目瞭然知道模組目前的狀態。

Build

• 
• 建構的狀態

Code Coverage

• 
• 測試涵蓋率

Dependencies

• 
• 相依的外部模組狀態

Downloads

• 
• 模組下載次數

License

• 
• 授權的類型

Version

• 
• 版本

Intro

通常包括

• Installation and Usage
• how to start?
• Feature 列表

Test

說明怎麼執行測試程式

npm test

Maintainers

主要維護者資訊

[alincode](https://github.com/alincode) - **AILIN LIOU** (author)

License

授權的類型

MIT © [alincode](https://github.com/alincode)

好用工具

可以自動產生 README 格式

https://www.npmjs.com/package/readme-md-generator

延伸閱讀

• Quality metadata badges for open source projects