Skip to content

Instantly share code, notes, and snippets.

What would you like to do?
A quick outline of a 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.