Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

[#1206] Added purpose to README example, cleaned up comments a bit

  • Loading branch information...
commit e6258f44e2f3ca0d71bbc0a9413649636a0a6f20 1 parent 36bef61
David Seifried dseif authored
Showing with 6 additions and 2 deletions.
  1. +6 −2 README.md
8 README.md
View
@@ -33,12 +33,16 @@ All of our documentation is written in [Markdown](http://daringfireball.net/proj
// Title as it will appear on the page, probably the same as the above title
# Footnote #
- // A brief explanation of what this method/function/etc is supposed to do
+ // A header for the purpose
## Purpose ##
- // If there are any options that need to be explained (function parameters, object properties, etc) do it here
+ // A brief explanation of what this method/function/etc is supposed to do
+ Adds text to an element on the page.
+
+ // A header for the options (if there is any)
## Options ##
+ // If there are any options that need to be explained (function parameters, object properties, etc) do it here
// A bulleted list describing each option
// Be sure to specify the desired type(s) i.e Number
* **start** \[Number\] - The time you want the footnote to appear.
Please sign in to comment.
Something went wrong with that request. Please try again.