Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dcalhoun committed Apr 15, 2017
1 parent 32885a8 commit 3b9705c
Showing 1 changed file with 19 additions and 16 deletions.
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,40 @@
# hyperterm-summon
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.

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 Mac OS only) your previously-active application will regain focus.

## Install

## Installation
1. Add `hyperterm-summon` to your plugins array in `~/.hyperterm.js`.
2. Add a `summonShortcut` entry inside the `config` object and 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)
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).

```js
## 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
```js
module.exports = {
config: {
summonShortcut: 'Alt+Super+O'
summon: {
hideDock: true,
hotkey: 'Alt+Super+O'
}
},
plugins: [
'hyperterm-summon'
]
}
```

## Valid shortcuts

## 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:

#### Examples:
* `CommandOrControl+A`
* `CommandOrControl+Shift+Z`


#### Available modifiers

#### Available Modifiers
* `Command` (or `Cmd` for short)
* `Control` (or `Ctrl` for short)
* `CommandOrControl` (or `CmdOrCtrl` for short)
Expand All @@ -40,8 +44,7 @@ Examples:
* `Shift`
* `Super`

#### Available key codes

#### Available Key Codes
* `0` to `9`
* `A` to `Z`
* `F1` to `F24`
Expand Down

0 comments on commit 3b9705c

Please sign in to comment.