Create README.md

Wixel · Jan 9, 2015 · 78b2b6a · 78b2b6a
1 parent db22081
commit 78b2b6a
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# readingbar (jQuery plugin)
+A simple progress bar that indicates the length &amp; your current reading position of an article/page
+
+[Here's a demo](http://codepen.io/WixelHQ/pen/bNBzZx)
+
+### Adding it to your site
+``` js
+// select the element you wish to track (ie. in a blog post target only the container of the actual post content)
+$('.article').readingbar();
+```
+
+### Options
+``` js
+// you can set the height and the color of the bar.
+$('.article').readingbar({
+  height: '10px',
+  backgroundColor: '#22252C'
+});
+```