diff --git a/README.md b/README.md index f9d509b8..0a17f98a 100644 --- a/README.md +++ b/README.md @@ -9,22 +9,26 @@ GitHub UI integration for KS - Kernel Scheduling Method 1. Click on 'Add to Chrome' ## From the Source Code (for development or for external contributors) -1. Go to `chrome://extensions` -1. Make sure you have _Developer Mode_ enabled at the top -1. Click _Load Unpacked Extension_ -1. Navigate to the `dist` folder and select it - - Note: Do this after running `npm i` then `npm run web` or `npm run build` + +1. Open Source code and then run `npm i` then `npm run web` or `npm run build` +2. Go to `chrome://extensions` +3. Make sure you have _Developer Mode_ enabled at the top +4. Click _Load Unpacked Extension_ +5. Navigate to the `dist` folder and select it + # Installing on Firefox ## The "published" version 1. https://stackoverflow.com/c/expensify/questions/7053/7054#7054 ## From the Source Code (for development or for external contributors) -1. Open up this page in firefox: `about:debugging#/runtime/this-firefox` -1. Click **Load temporary add-on** -1. Select the `dist/manifest.json` file in this repo (really any file within the dist should work) [more info](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension#Trying_it_out) -1. Go to https://github.com/Expensify/App#k2 - Note: If this doesn't load you may need to run `npm run build` within the root of the repo to ensure all files have been generated properly (we don't save all of the dist directory to the repo). + +1. Open Source code and then run `npm i` then `npm run web` or `npm run build` +2. Open up this page in firefox: `about:debugging#/runtime/this-firefox` +3. Click **Load temporary add-on** +4. Select the `dist/manifest.json` file in this repo (really any file within the dist should work) [more info](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension#Trying_it_out) +5. Go to https://github.com/Expensify/App#k2 + Note: We don't save all of the dist directory to the repo, so you may need to run `npm run build` within the root of the repo to ensure all files have been generated properly. ## NOTE: It Requires a Personal Access token Your personal access token is stored locally and securely. It is used to make basic auth calls to the GitHub API. This is so that we don't have to implement OAuth or a separate API and we can get around a lot of the rate limiting issues.