Skip to content

Instantly share code, notes, and snippets.

@spences10

spences10/README.md

Last active March 22, 2018 17:16
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save spences10/7db9883514c9ffd5005f1a0a832f18f5 to your computer and use it in GitHub Desktop.
Save spences10/7db9883514c9ffd5005f1a0a832f18f5 to your computer and use it in GitHub Desktop.
Download ZIP
Readme pattern
Raw
README.md

README pattern

Optimal README layout from Kent Dodds source:

  1. Title + tagline + logo?
  2. Badges
  3. The problem
  4. The solution
  5. TOC
  6. Installation
  7. Usage
  8. FAQ
  9. Inspiration
  10. Alternatives
  11. Contributors
  12. License
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment