Skip to content

Commit

Permalink
Remove Accelerator documentation from README
Browse files Browse the repository at this point in the history
Remove to avoid potential of becoming stale. No real need to
re-document another library's documentation.
  • Loading branch information
dcalhoun committed Apr 17, 2017
1 parent 8ac107e commit a3ad550
Showing 1 changed file with 7 additions and 41 deletions.
48 changes: 7 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,20 @@
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 |
| --- | ----------- | ------- |
| `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: {
Expand All @@ -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`

0 comments on commit a3ad550

Please sign in to comment.