diff --git a/README.md b/README.md index 9e4a4e6..2ee892c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -#jQuery UI Slider Pips -####Plugin to add "pips" or "floats" to a JQUI Slider. +# jQuery UI Slider Pips +#### Plugin to add "pips" or "floats" to a JQUI Slider. [![Join the chat at https://gitter.im/simeydotme/jQuery-ui-Slider-Pips](https://badges.gitter.im/simeydotme/jQuery-ui-Slider-Pips.svg)](https://gitter.im/simeydotme/jQuery-ui-Slider-Pips?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -8,17 +8,17 @@ This plugin **extends** the [jQuery UI Slider widget](http://jqueryui.com/slider Use it for creating a nicely-styled slider like shown below [Documentation, Demos and Examples here](http://simeydotme.github.io/jQuery-ui-Slider-Pips/) -=== +--- #### Want to contribute?: Please make sure to create a JSFiddle to demonstrate any problems, or pull requests, with this as a base: http://jsfiddle.net/simeydotme/Lh6pygef/ (press **fork** on the toolbar) -=== +--- ![Default settings for the plugin](http://files.simey.me/pips.jpg "Example of Pips plugin with default options") ![Example of the slider in use](https://cloud.githubusercontent.com/assets/2817396/3999716/d887ebf2-2952-11e4-9044-0c1b6baba99a.gif "Slider being used by a person with a mouse") -###Install +### Install If you're using [Bower](http://bower.io) you can install this plugin quickly from the command-line! :) ```bash bower install jquery-ui-slider-pips --save @@ -28,18 +28,18 @@ Otherwise, you may download the files in the `/dist/` folder. ------------------------------------ -###Requirements: +### Requirements: - jQuery (1.9+) - jQuery UI (1.10+) ------------------------------------ -###Usage: +### Usage: Include the plugin javascript file __after__ jQuery & jQuery-ui. Include the CSS file; edit as you please. _Below methods are chainable, I've shown them separate for clarity_ -####Default usage: +#### Default usage: ```html