Skip to content

Commit

Permalink
[change] Update installation documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dcalhoun committed Apr 28, 2018
1 parent b2694e4 commit 7972394
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Expand Up @@ -4,19 +4,25 @@

Summon your Hyper windows with a system-wide hotkey.

In a multi-window situation, hyperterm-summon will remember the last active window and restore focus to it.
In a multi-window situation, hyperterm-summon will remember the last active
window and restore focus to it.

If Hyper 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.
If Hyper 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. Open your Hyper config file (i.e. `~/.hyper.js`) in your preferred text editor.
1. Add `hyperterm-summon` to the plugins array found in the Hyper config.
Use the hyper command, bundled with your Hyper app, to install hyperterm-summon
by entering the following into Hyper:
```bash
hyper i hyperterm-summon
```

## Options
| Key | Description | Default |
| --- | ----------- | ------- |
| `hideDock` | Hide the Hyper icon in the dock and app switcher. | `false` |
| `hideOnBlur` | Hide the Hyper when window loses focus. | `false` |
| `hideOnBlur` | Hide the Hyper when window loses focus. | `false` |
| `hotkey` | Shortcut to toggle Hyper window visibility. | `Ctrl+;` |

*NOTE:* For a list of valid shortcuts, see [Electron Accelerators](https://github.com/electron/electron/blob/master/docs/api/accelerator.md).
Expand Down

0 comments on commit 7972394

Please sign in to comment.