Skip to content

Instantly share code, notes, and snippets.

@indexzero

indexzero/readme-outline.md

Created November 14, 2011 08:26
Show Gist options
  • Save indexzero/1363524 to your computer and use it in GitHub Desktop.
Save indexzero/1363524 to your computer and use it in GitHub Desktop.
Download ZIP
A quick outline of a README.md
Raw
readme-outline.md

README.md Outline

  • Header and a Brief description (should match package.json)
  • Example (if applicable)
  • Motivation (if applicable)
  • API Documentation: This will likely vary considerably from library to library.
  • Installation
  • Tests
  • Contributors
  • License

Bonus Points

  1. The file is named exactly README.md (not ReadMe.md, or README)
  2. The license file is named exactly LICENSE (not MIT-LICENSE, or license)
  3. The entire license is not included in README.md, just a snippet saying it is MIT or Apache or whatever
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment