From 33c770892e0bb9f6e4027fff89d8a30ae9a47cf8 Mon Sep 17 00:00:00 2001
From: Chris Saylor <cjsaylor@gmail.com>
Date: Sat, 31 Aug 2013 01:56:36 -0400
Subject: [PATCH] Updated readme.

---
 README    | 22 ----------------------
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+), 22 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index b34da04..0000000
--- a/README
+++ /dev/null
@@ -1,22 +0,0 @@
-Scrolltab is a jQuery plugin that adds tabs visually associated to their position relative to the scroll bar.
-
-This enabled a developer to attach floating tabs to the scrollbar of the brwoser that will scroll the user to the position indicated by the tab.  This tab is expandable with content within.
-
-Demo: 
-	http://www.chris-saylor.com/demos/Scrolltab/example.html
-
-Examples:
-	// Enables a pin with the default classname
-	$('<dom object>').scrolltab();
-
-	// Changes the classname of the created (or existing) pin
-	$('<dom object>').scrolltab({ classname: 'test' });
-
-Options:
-	title: HTML to display within the pin
-	classname: The classname for the pin to use
-	hoverin: function to execute when the mouseenter event fires on this pin
-	hoverout: function to execute when the mouseleave event fires on this pin
-	click: function to execute when the click event fire on this pin
-
-This software is protected under the MIT license.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b8ea0ec
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+Scrolltab is a jQuery plugin that adds tabs visually associated to their position relative to the scroll bar.
+
+This enables a developer to attach floating tabs to the scrollbar of the brwoser that will scroll the user to the position indicated by the tab.  This tab is expandable with content within.
+
+## Demo
+	http://chris-saylor.com/Scrolltab/example.html
+
+## Examples
+
+```javascript
+	// Enables a pin with the default classname
+	$('<dom object>').scrolltab();
+
+	// Changes the classname of the created (or existing) pin
+	$('<dom object>').scrolltab({ classname: 'test' });
+```
+
+## Options
+
+* `title`: HTML to display within the pin
+* `classname`: The classname for the pin to use
+* `mouseenter`: function to execute when the mouseenter event fires on this pin
+* `mouseleave`: function to execute when the mouseleave event fires on this pin
+* `click`: function to execute when the click event fire on this pin
+
+## Build
+
+Scrolltab uses Grunt for linting and building the minified production file.
+
+### Requirements
+
+* NodeJS
+
+#### Setup
+
+Install grunt cli globally:
+
+`$ npm install -g grunt-cli`
+
+Install dev dependencies:
+
+`$ npm install -d`
+
+Execute lint and build:
+
+`$ grunt`
+
+## License
+
+This software is protected under the MIT license.