/readme

A readme file template for repositories.

Title of Project

Summary

A short description of what the the thing does.

Requirements

  • A list of requirements
  • Any libraries
  • Framework dependencies
  • Etc.

How to Use

  1. An ordered list of instructions
  2. On how to use
  3. Or implement it
  4. This is how you bold and italicize
  5. Here's a quote

Something important that should be highlighted

  1. And here's a horizontal line

Example

Here is some inline code: var tiger

And some block-formatted code:

Example.load({
  console.log("Test!");
});

Documentation