From 68c2290c4926fd116dbce8bb567ccb2e0e860758 Mon Sep 17 00:00:00 2001 From: Jose Garcia Date: Tue, 6 Feb 2024 15:34:46 -0700 Subject: [PATCH] Add installation links and development info to README --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 40 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5bfeaea..9deef18 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ -# GitKraken Browser extension +# GitKraken Browser Extension + +## Installation + +[Google Chrome](https://chromewebstore.google.com/detail/gitkraken/egmopflbpgdjmmkeabegohajillnebco) + +[Microsoft Edge](https://microsoftedge.microsoft.com/addons/detail/gitkraken/eehliiniplilmbgcnghhaneefihofjnl) + +[Mozilla Firefox](https://addons.mozilla.org/en-US/firefox/addon/gitkraken-browser-extension) ## Features @@ -6,9 +14,39 @@ - Adds a "Checkout with GitKraken" option to the `Code` dropdowns on pull requests on GitHub - Adds a "Open with GitKraken" button to commit pages on GitHub -## Installation +## Latest Preview - Grab the latest release from the [Releases](https://github.com/gitkraken/gitkraken-browser/releases) page - Go to the extensions page in your browser, e.g. `chrome://extensions` or `edge://extensions` - Enable "Developer mode" - Drag the downloaded zip file, `gitkraken-browser*.zip`, and drop it onto the extensions page + +## Development + +Building this project requires [Node.js](https://yarnpkg.com) and [Yarn](https://yarnpkg.com). + +### Install dependencies + +```sh +yarn +``` + +### Developing for Chrome/Edge: + +```sh +yarn build:chromium +# OR +yarn watch:chromium +``` + +Open `chrome://extensions/` or `edge://extensions/`, enable Developer Mode, then drag the `gk-browser-extension` folder onto the page to install the extension. + +### Developing for Firefox: + +```sh +yarn build:firefox +# OR +yarn watch:firefox +``` + +Open `about:debugging#/runtime/this-firefox`, click "Load Temporary Add-on", then select any file in the root of the `gk-browser-extension` folder.