From aecbbc5fb15885a05a5b9605001cc2b81053c3b7 Mon Sep 17 00:00:00 2001 From: Kyle Spearrin Date: Tue, 20 Feb 2018 11:36:27 -0500 Subject: [PATCH] Update README.md --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index e5a4e3e3..4f2e786b 100644 --- a/README.md +++ b/README.md @@ -16,16 +16,13 @@ The Bitwarden desktop app is written using Electron and Angular. The application **Requirements** - [Node.js](https://nodejs.org/en/) +- Windows users: To compile the native node modules used in the app you will need the Visual C++ toolset, available through the standard Visual Studio installer (recommended) or by installing [`windows-build-tools`](https://github.com/felixrieseberg/windows-build-tools) through `npm`. See more at [Compiling native Addon modules](https://github.com/Microsoft/nodejs-guidelines/blob/master/windows-environment.md#compiling-native-addon-modules). + +**API endpoint** 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 instance. Open `jslib/src/services/api.service.ts` and set `this.baseUrl` and `this.identityBaseUrl` to your local API instance (ex. `http://localhost:5000`). -You should also make sure that you have pulled the latest for the [`jslib`](https://github.com/bitwarden/jslib) submodule by running: - -```git -git submodule update --init --recursive -``` - -Then run the following commands: +**Run the app** ```bash npm install