aboutsummaryrefslogtreecommitdiffstats
path: root/lib/mousetrap/plugins/bind-dictionary/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/mousetrap/plugins/bind-dictionary/README.md')
-rw-r--r--lib/mousetrap/plugins/bind-dictionary/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/lib/mousetrap/plugins/bind-dictionary/README.md b/lib/mousetrap/plugins/bind-dictionary/README.md
new file mode 100644
index 0000000..6f956b6
--- /dev/null
+++ b/lib/mousetrap/plugins/bind-dictionary/README.md
@@ -0,0 +1,16 @@
+# Bind Dictionary
+
+This extension overwrites the default bind behavior and allows you to bind multiple combinations in a single bind call.
+
+Usage looks like:
+
+```javascript
+Mousetrap.bind({
+ 'a': function() { console.log('a'); },
+ 'b': function() { console.log('b'); }
+});
+```
+
+You can optionally pass in ``keypress``, ``keydown`` or ``keyup`` as a second argument.
+
+Other bind calls work the same way as they do by default.