Skip to content

Commit

Permalink
better instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Jarred-Sumner committed Feb 13, 2021
1 parent 0b80142 commit f8ba997
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 10 deletions.
10 changes: 2 additions & 8 deletions POST-INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## Installing git-peek

You'll need to have [`git-peek`](https://github.com/jarred-sumner/git-peek) installed for this to work.
You'll need to have [`git-peek`](https://github.com/jarred-sumner/git-peek) installed for this to work and only macOS is supported for now.

To do that, run this:

```bash
npm install -g git-peek
```

Next, you'll need to register the `git-peek://` URL handler. Just run this comnad:
Next, you'll need to register the `git-peek://` URL handler. Just run this:

```bash
git peek -r
Expand All @@ -19,9 +19,3 @@ Then, header over to the test page:
<a href="https://github.com/Jarred-Sumner/1-click-from-github-to-editor/blob/main/TEST-PAGE.md">
<img src="./test-button-img.png" height="48" />
</a>

<br />

If you want to configure git-peek, header over to the main [git-peek repo](https://github.com/Jarred-Sumner/git-peek).

Note: currently only macOS is supported. Any non-terminal based editor should work (sorry vim users! I don't know how to make it work in vim yet.)
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 1-click from GitHub to editor
# 1-click from GitHub to local editor

<img src="./screenshot-1.png" height=400 />
<a<img src="./screenshot-1.png" height=400 />

Instantly open files, pull requests, and repositories from GitHub in your local editor. Read, search, and review code from the comfort of your own local editing environment.

Expand Down
2 changes: 2 additions & 0 deletions TEST-PAGE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
### git-peek test page

Do you see an "Open (git-peek)" button in the header? Try clicking it. If it works, this page will open up in your local editing environment.

If you want to configure git-peek, header over to the main [git-peek repo](https://github.com/Jarred-Sumner/git-peek).

0 comments on commit f8ba997

Please sign in to comment.