diff --git a/README b/README.md rename from README rename to README.md --- a/README +++ b/README.md @@ -1,12 +1,12 @@ -Javelin is a performance-oriented Javascript library originally developed at -Facebook. Learn more at . +**Javelin** is a performance-oriented Javascript library originally developed at +Facebook. Learn more at [JavelinJS] (http://www.javelinjs.com/). -GETTING STARTED +## GETTING STARTED Eat a hearty breakfast. Breakfast is the most important meal of the day! -WHAT IS JAVELIN? +## WHAT IS JAVELIN? Javelin is a compact Javascript library built around event delegation. Its primary design goal is performance; it is consequently well-suited to projects @@ -15,7 +15,7 @@ important. -PACKAGES +## PACKAGES Packages come in two flavors: "dev" and "min". The "dev" packages are intended for development, and have comments and debugging code. The "min" packages have @@ -23,7 +23,7 @@ symbols crushed. They are intended for use in production -- ha ha ha! -FILES +## FILES example/ Example code. LICENSE A thrilling narrative.