Merge pull request electron#2164 from hankbao/global-shortcut-doc-update

Update global-shortcut.md
phlogisticfugu · Jul 10, 2015 · a24d292 · a24d292
2 parents 5ae57ba + fc9612a
commit a24d292
Showing 1 changed file with 19 additions and 11 deletions.
diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md
@@ -3,25 +3,33 @@
 The `global-shortcut` module can register/unregister a global keyboard shortcut
 in operating system, so that you can customize the operations for various shortcuts.
 Note that the shortcut is global, even if the app does not get focused, it will still work.
+You should not use this module until the ready event of app module gets emitted.
 
 ```javascript
+var app = require('app');
 var globalShortcut = require('global-shortcut');
 
-// Register a 'ctrl+x' shortcut listener.
-var ret = globalShortcut.register('ctrl+x', function() { console.log('ctrl+x is pressed'); })
+app.on('ready', function() {
+  // Register a 'ctrl+x' shortcut listener.
+  var ret = globalShortcut.register('ctrl+x', function() {
+    console.log('ctrl+x is pressed');
+  })
 
-if (!ret) {
-  console.log('registration failed');
-}
+  if (!ret) {
+    console.log('registration failed');
+  }
 
-// Check whether a shortcut is registered.
-console.log(globalShortcut.isRegistered('ctrl+x'));
+  // Check whether a shortcut is registered.
+  console.log(globalShortcut.isRegistered('ctrl+x'));
+});
 
-// Unregister a shortcut.
-globalShortcut.unregister('ctrl+x');
+app.on('will-quit', function() {
+  // Unregister a shortcut.
+  globalShortcut.unregister('ctrl+x');
 
-// Unregister all shortcuts.
-globalShortcut.unregisterAll();
+  // Unregister all shortcuts.
+  globalShortcut.unregisterAll();
+});
 ```
 
 ## globalShortcut.register(accelerator, callback)