From 41fb290666243cc1c10e7498e597b5877b04cf24 Mon Sep 17 00:00:00 2001 From: Kyle Spearrin Date: Wed, 28 Dec 2016 23:53:58 -0500 Subject: [PATCH] readme updates --- CONTRIBUTING.md | 2 ++ README.md | 8 +++++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56a66ab2e1..29a7a02e42 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,5 +19,7 @@ when creating your pull request: 5. Test your translations to make sure they look correct in the extension. Sometimes the UI can break due to translations taking up more space than the original UI was built for. If possible, use a shorter or abbreviated version of the word/sentence to accomedate the available space. +6. Be sure to watch for [future changes](https://github.com/bitwarden/browser/commits/master/src/_locales/en/messages.json) + to the `/src/_locales/en/messages.json` file so that your translation will stay up to date. You can find an example of a proper translation pull request here: diff --git a/README.md b/README.md index 22c906f069..a89599fc5b 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,13 @@ The bitwarden browser extension is written using the Chrome Web Extension API an **Requirements** -- Node.js -- Gulp +- [Node.js](https://nodejs.org/en/) +- [Gulp](http://gulpjs.com/) (`npm install --global gulp-cli`) - 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`). +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: