Created

Embed URL

HTTPS clone URL

SSH clone URL

You can clone with HTTPS or SSH.

Download Gist

A quick outline of a README.md

View readme-outline.md
  • 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
Something went wrong with that request. Please try again.