Last active

A quick outline of a

  • Download Gist
Markdown 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 (not, or README)
  2. The license file is named exactly LICENSE (not MIT-LICENSE, or license)
  3. The entire license is not included in, just a snippet saying it is MIT or Apache or whatever

Please sign in to comment on this gist.

Something went wrong with that request. Please try again.