@@ -4,18 +4,31 @@ Create your own keymap to display the keybinings of your software with jQuery.
44
55##Installation/Quickstart
66
7- - Download the zip file and unzip it to your server directory.
8- - Include the file: `` <script src="/js/keymap.js"></script> ``
9- - Call the plugin on the `` div `` you want to place the keymap.
10- - `` $('.keymap').keymap(); ``
11- - Creating your keybings by calling `` $('.shortcut').createShortcut('.keymap', ["ctrl", "s"], {},":first"); ``
7+ - Download the zip file and unzip it.
8+ - Include ` keymap.js ` and ` keymap.css `
9+ ``` HTML
10+ <!--
11+ Include Keymap
12+ -->
13+ <script src =" //code.jquery.com/jquery-1.11.3.min.js" ></script >
14+ <script src =" keymap.js" ></script >
15+ <link href =keymap.css " rel=" stylesheet " >
16+ ```
17+ - Initiate the plugin
18+ ```Javascript
19+ $(document).ready(function(){
20+ $.getJSON('layouts/qwerty.json', function(json){
21+ $('.keymap').keymap({" css " : {" key " : {" background " : " white " , " color " : " black " }}});
22+ $('.shortcut').createShortcut('.keymap', [" ctrl " , " s " ], {}, " :first " );
23+ });
24+ });
25+ ```
1226- For more details: Check the [wiki](https://github.com/Andr3as/jQuery-Keymap/wiki)
1327
1428##Examples
1529
16- ####[ Live preview] ( http://andr3as.github.io/jQuery-Keymap )
17-
18- ![ Example] ( http://andrano.de/Plugins/img/keymap.jpg " Example ")
30+ 
31+ #####[Live preview on Andrano.de](https://andrano.de/Keymap)
1932
2033##Contribute
2134You want to contribute a new layout or some fixes create a pull request or send an email to [andranode[at]gmail.com](mailto://andranode@gmail.com)
0 commit comments