readme

[travi]

@travi commented on Thu Nov 24 2016

consider a library to generate/maintain the readme

• https://github.com/bevry/projectz
• badges (leveraged in projectz)

---

@travi commented on Thu Nov 24 2016

• https://github.com/noffle/art-of-readme
• https://github.com/matiassingers/awesome-readme#articles

---

@travi commented on Sun Feb 18 2018

• https://github.com/jonschlinkert/markdown-toc
• https://github.com/thlorenz/doctoc

---

@travi commented on Sun Feb 18 2018

group badges

consumer info

• license
• version/registry
• download

status info

• build status
• coverage
• nsp vulnerabilities

contribution info

• publish method (semantic-release)
• commit convention (conventional commits)
• commit convention helper/wizard (commitizen enabled)
• dependency update strategy (greenkeeper)
• PRs welcome

[travi]

sections

usage

installation

contribution

dependencies

verification

[travi]

emoji for headings?

🎰 usage

💾or :cd: installation

😇 contribution

📦 dependencies

:100: or ✅ or ✔️ verification

others: https://gist.github.com/rxaviers/7360908

[travi]

• remarkable
• remark