From 78b2b6abc39a6a9f0e7041e6c26cd2bd825e2202 Mon Sep 17 00:00:00 2001 From: Nico van Zyl Date: Fri, 9 Jan 2015 11:38:58 +0200 Subject: [PATCH] Create README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1b7f670 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# readingbar (jQuery plugin) +A simple progress bar that indicates the length & 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' +}); +```