From a3ad550f0ecf9325caeb0df3580f4617db7914c2 Mon Sep 17 00:00:00 2001
From: David Calhoun <dpcalhoun@gmail.com>
Date: Sun, 16 Apr 2017 21:31:44 -0500
Subject: [PATCH] Remove Accelerator documentation from README

Remove to avoid potential of becoming stale. No real need to
re-document another library's documentation.
---
 README.md | 48 +++++++-----------------------------------------
 1 file changed, 7 insertions(+), 41 deletions(-)

diff --git a/README.md b/README.md
index d6409a8..de6cfd4 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,12 @@
 Summon your Hyperterm windows with a system-wide hotkey. In a multi-window situation, hyperterm-summon will remember which window was active last and restore focus to it. If HyperTerm is already active when the hotkey is pressed, your terminal windows will be hidden and (on macOS only) your previously-active application will regain focus.
 
 ## Installation
-1. Add `hyperterm-summon` to your plugins array in `~/.hyperterm.js`.
-2. Add a `summon` entry inside the `config` object.
-3. Add a `hotkey` entry inside the `summon` object. Set the value to the shortcut you want to use (see [Electron Accelerators](https://github.com/electron/electron/blob/master/docs/api/accelerator.md) for valid shortcuts).
+1. Open your Hyper config file (i.e. `~/.hyperterm.js`) in your preferred text editor.
+1. Add `hyperterm-summon` to the plugins array found in the Hyper config.
+1. Inside the Hyper `config` object, add a `summon` entry to house your `hyperterm-summon` config.
+1. Within the `summon` entry, add a `hotkey` entry assigned your preferred shortcut key binding.
+
+*NOTE:* For a list of valid shortcuts, see [Electron Accelerators](https://github.com/electron/electron/blob/master/docs/api/accelerator.md).
 
 ## Options
 | Key        | Description                                       | Default |
@@ -12,7 +15,7 @@ Summon your Hyperterm windows with a system-wide hotkey. In a multi-window situa
 | `hotkey`   | Shortcut to toggle Hyper window visibility.       | None    |
 | `hideDock` | Hide the Hyper icon in the dock and app switcher. | `false` |
 
-## Example
+## Example Config
 ```js
 module.exports = {
   config: {
@@ -26,40 +29,3 @@ module.exports = {
   ]
 }
 ```
-
-## Valid Shortcuts
-Valid shortcuts are defined by Electron and are known as **Accelerators**. Accelerators can contain multiple modifiers and key codes, combined by the + character.
-
-#### Examples:
-* `CommandOrControl+A`
-* `CommandOrControl+Shift+Z`
-
-#### Available Modifiers
-* `Command` (or `Cmd` for short)
-* `Control` (or `Ctrl` for short)
-* `CommandOrControl` (or `CmdOrCtrl` for short)
-* `Alt`
-* `Option`
-* `AltGr`
-* `Shift`
-* `Super`
-
-#### Available Key Codes
-* `0` to `9`
-* `A` to `Z`
-* `F1` to `F24`
-* Punctuations like `~`, `!`, `@`, `#`, `$`, etc.
-* `Plus`
-* `Space`
-* `Tab`
-* `Backspace`
-* `Delete`
-* `Insert`
-* `Return` (or `Enter` as alias)
-* `Up`, `Down`, `Left` and `Right`
-* `Home` and `End`
-* `PageUp` and `PageDown`
-* `Escape` (or `Esc` for short)
-* `VolumeUp`, `VolumeDown` and `VolumeMute`
-* `MediaNextTrack`, `MediaPreviousTrack`, `MediaStop` and `MediaPlayPause`
-* `PrintScreen`