Skip to content

Commit dce1ebc

Browse files
committed
Adds README with example .gif
1 parent c93f2da commit dce1ebc

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# gitrocket
2+
A fun plugin for the [Hyper](https://hyper.is/) terminal that launches a rocket
3+
ship when you push code with Git.
4+
5+
![gitrocker usage GIF](https://user-images.githubusercontent.com/6589909/28004019-64163b4a-6507-11e7-832e-c95a4bd71c2b.gif)
6+
7+
### Installation
8+
To use this plugin, first install the plugin in your `~/.hyper_plugins`
9+
folder.
10+
```
11+
$ cd ~/.hyper_plugins
12+
$ npm install gitrocket
13+
```
14+
Then add the plugin's name in your `~/.hyper.js` file as an item in the
15+
`plugins` array.
16+
```
17+
plugins: [
18+
"gitrocket"
19+
],
20+
```
21+
22+
Afterwards, refresh your Hyper terminal with _View > Full Reload_.
23+
24+
### Development
25+
To run a local version of this plugin, clone it in your
26+
`~/.hyper_plugins/local` folder.
27+
```
28+
$ cd ~/.hyper_plugins/local
29+
$ git clone git@github.com:bomanimc/gitrocket.git
30+
```
31+
Then add the plugin's name in your `~/.hyper.js` file as an item in the
32+
`plugins` array.
33+
```
34+
localPlugins: [
35+
"gitrocket"
36+
],
37+
```
38+
Afterwards, use `npm run build` to create a `/dist` folder. Lastly, refresh
39+
you terminal.

video.gif

581 KB
Loading

0 commit comments

Comments
 (0)