Update README.md to reflect option.splitKey (#106)

6 years ago · 4d9bd7808d
parent 44283e7c1e
commit 4d9bd7808d
1 changed files with 9 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -152,6 +152,7 @@ hotkeys('*','wcj', function(event){
 - `element<HTMLElement>`
 - `keyup<Boolean>`
 - `keydown<Boolean>`
+- `splitKey<string>` (default is `+`)

 ```js
 hotkeys('o, enter', {
@ -160,6 +161,14 @@ hotkeys('o, enter', {
 }, function(){ 
  console.log('do something else');
 });
+
+hotkeys('ctrl-+', {splitKey: '-'}, function(e) {
+  console.log('you pressed ctrl and +');
+});
+
+hotkeys('+', {splitKey: '-'}, function(e){
+  console.log('you pressed +');
+})
 ```

 ## API REFERENCE