freeCodeCamp / freeCodeCamp/100DaysOfCode-twitter-bot
Update docs to the KCD README pattern
Open
documentation
enhancement
good first issue
help wanted
- Dominant language
- JavaScript
- Stars
- 290
- Forks
- 109
- PR merge metrics
- No merged PRs in 30d
Description
# README pattern
Optimal README layout from Kent Dodds [source]:
1. Title + tagline + logo?
1. Badges
1. The problem
1. The solution
1. TOC
1. Installation
1. Usage
1. FAQ
1. Inspiration
1. Alternatives
1. Contributors
1. License
[source]: https://twitter.com/kentcdodds/status/976813153647394816
Contributor guide
Assessment
This issue has not been assessed yet.