Skip to content

Commit

Permalink
update readme (still need to add release)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jarred-Sumner committed Feb 13, 2021
1 parent 693a9f1 commit acd55fe
Show file tree
Hide file tree
Showing 7 changed files with 87 additions and 3 deletions.
Binary file modified .DS_Store
Binary file not shown.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
node_modules
.env
**/*.env
/extension/web-ext-artifacts
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,21 @@ This extension requires installing git-peek to register the URL handler – head

## Installation

To install the chrome extension:
### Chrome

1. [Download git-peek for Chrome](`https://github.com/Jarred-Sumner/1-click-from-github-to-editor/releases/download/v0/git-peek-chrome-extension.zip`)

1. [Download the extension](`https://github.com/Jarred-Sumner/1-click-from-github-to-editor/releases/download/v0/git-peek-chrome-extension.zip`)
2. Drag and drop the `.zip` file into `chrome://extensions`

It'll be in the Chrome Store eventually. The source for the extension is in this repo if you want to look at the code yourself.

Most of the real code for this is in the [`git-peek`](https://github.com/jarred-sumner/git-peek) repository. All this does is add buttons that open the `git-peek://` URL handler with the right URLs.
### Firefox

1. [Download git-peek for Firefox](`https://github.com/Jarred-Sumner/1-click-from-github-to-editor/releases/download/v0/git-peek-chrome-extension.zip`)

2. Drag and drop the file into Firefox.

It'll be in the Firefox Addon Marketplace eventually. It's being reviewed.

<img src="./screenshot-2.png" height=400 />
<img src="./screenshot-3.png" height=400 />
3 changes: 3 additions & 0 deletions extension/.web-extension-id
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# This file was created by https://github.com/mozilla/web-ext
# Your auto-generated extension ID for addons.mozilla.org is:
{3f537cbb-125f-4a7f-bb72-248525604184}
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"devDependencies": {
"dotenv-cli": "^4.0.0",
"esbuild": "^0.8.44",
"web-ext-types": "^3.2.1"
},
Expand All @@ -12,6 +13,7 @@
"prebuild": "rm -rf ./extension/dist",
"build": "cd extension; node build.js; cd ../",
"create-zip": "ditto -c -k --sequesterRsrc ./extension ./git-peek-chrome-extension.zip",
"do-sign": "cd extension && WEB_EXT_API_KEY=$WEB_EXT_API_KEY WEB_EXT_API_SECRET=$WEB_EXT_API_SECRET web-ext sign",
"preship": "pnpm create-zip"
},
"name": "git-peek-chrome-extension"
Expand Down
69 changes: 69 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added share-image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit acd55fe

Please sign in to comment.