Skip to content
Browse files

update readme

  • Loading branch information...
1 parent 1d8b6a5 commit f83f7deb4ff753dc11538fae80ee63965181dac9 @madrobby committed Nov 10, 2012
Showing with 12 additions and 0 deletions.
  1. +12 −0 README.markdown
View
12 README.markdown
@@ -123,6 +123,18 @@ If you only want _some_ shortcuts to work while in a input element, you change t
key.filter function; however a more robust way to handle this is to use proper
focus and blur event handlers on your input element, and change scopes there as you see fit.
+## noConflict mode
+
+You can call ```key.noConflict``` to remove the ```key``` function from global scope and restore whatever ```key``` was defined to before Keymaster was loaded. Calling ```key.noConflict``` will return the Keymaster ```key``` function.
+
+```javascript
+var k = key.noConflict();
+k('a', function() { /* ... */ });
+
+key()
+// --> TypeError: 'undefined' is not a function
+```
+
## Notes
Keymaster should work with any browser that fires `keyup` and `keydown` events,

0 comments on commit f83f7de

Please sign in to comment.
Something went wrong with that request. Please try again.