diff --git a/README.md b/README.md index 4fc2ba4..8ab39a8 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ jQuery Knob ============= -- canvas based ; no png or jpg sprites. -- touch, mouse and mousewheel, keyboard events implemented. -- downward compatible ; overloads an input element. +- HTML5 canvas based; no png or jpg sprites. +- touch, mouse and mousewheel keyboard events can be used to control knobs. +- Backwards compatible, including graceful degradation in older browsers (most notably IE 6 - 9) Example ------- - +```HTML - +``` Options ------- Options are provided as attributes 'data-option': - +```HTML - -... or in the "knob()" call : - +``` +... or in the `knob()` call : +```javascript $(".dial").knob({ 'min':-50 ,'max':50 }); - +``` The following options are supported : Behaviors : @@ -53,13 +53,13 @@ UI : Hooks ------- - +```javascript - +``` * 'release' : executed on release Parameters : @@ -85,7 +85,7 @@ The scope (this) of each hook function is the current Knob instance (refer to th Example ------- - +```javascript - +``` Dynamically configure ------- - +```javascript - +``` Set the value ------- - +```javascript - +``` Supported browser ------- @@ -129,7 +129,7 @@ Tested on Chrome, Safari, Firefox, IE 9.0. MIT License ------- -Copyright (C) 2013 Anthony Terrien +Copyright (C) 2013 Jonathan Libby Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in