From a6c6e9e29bebfa1241d2121b4530f602babd0b47 Mon Sep 17 00:00:00 2001 From: Kyle Spearrin Date: Sat, 24 Dec 2016 00:13:36 -0500 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 69d841308a..22c906f069 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,30 @@ The bitwarden browser extension is written using the Chrome Web Extension API an ![Alt text](http://imgur.com/C9p87nk.png "My Vault") +# Build/Run + +**Requirements** + +- Node.js +- Gulp +- Chrome (preferred), Opera, or Firefox browser + +By default the extension is targeting the production API. If you are running the [Core](https://github.com/bitwarden/core) API locally, you'll need to switch the extension to target your local API. Open `src/services/apiService.js` and set `this.baseUrl` to your local API instance (ex. `http://localhost:4000`). + +Then run the following commands: + +- `gulp build` + +You can now load the extension into your browser through the browser's extension tools page: + +- Chrome/Opera: + 1. Type `chrome://extensions` in your address bar to bring up the extensions page. + 2. Enable developer mode (checkbox) + 3. Click the "Load unpacked extension" button, navigate to the `src` folder of your local extension instance, and click "Ok". +- Firefox + 1. Type `about:debugging` in your address bar to bring up the add-ons page. + 2. Click the `Load Temporary Add-on` button, navigate to the `src/manifest.json` file, and "Open". + # Contribute Code contributions are welcome! Please commit any pull requests against the `master` branch. Learn more about how to contribute