1
0
mirror of https://github.com/bitwarden/browser.git synced 2024-12-26 17:08:33 +01:00
bitwarden-browser/README.md

50 lines
3.1 KiB
Markdown
Raw Normal View History

2017-03-21 23:05:18 +01:00
[![appveyor build](https://ci.appveyor.com/api/projects/status/github/bitwarden/browser?branch=master&svg=true)](https://ci.appveyor.com/project/bitwarden/browser)
2017-05-20 23:23:46 +02:00
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/bitwarden-browser/localized.svg)](https://crowdin.com/project/bitwarden-browser)
2016-10-14 04:03:11 +02:00
[![Join the chat at https://gitter.im/bitwarden/Lobby](https://badges.gitter.im/bitwarden/Lobby.svg)](https://gitter.im/bitwarden/Lobby)
2018-02-27 19:37:57 +01:00
# Bitwarden Browser Extension
2016-09-11 06:22:18 +02:00
2017-03-30 02:35:26 +02:00
<a href="https://chrome.google.com/webstore/detail/bitwarden-free-password-m/nngceckbapebfimnlniiiahkandclblb" target="_blank"><img src="https://imgur.com/3C4iKO0.png" width="64" height="64"></a>
2018-04-23 19:49:38 +02:00
<a href="https://addons.mozilla.org/firefox/addon/bitwarden-password-manager/" target="_blank"><img src="https://imgur.com/Dy442GK.png" width="64" height="64"></a>
2017-10-03 21:44:07 +02:00
<a href="https://www.microsoft.com/store/p/bitwarden-free-password-manager/9p6kxl0svnnl" target="_blank"><img src="https://imgur.com/RlmwPGO.png" width="64" height="64"></a>
2018-04-23 19:49:38 +02:00
<a href="https://addons.opera.com/extensions/details/bitwarden-free-password-manager/" target="_blank"><img src="https://imgur.com/nSJ9htU.png" width="64" height="64"></a>
2018-02-27 20:22:46 +01:00
<a href="https://safari-extensions.apple.com/details/?id=com.bitwarden.safari-LTZ2PFU5D6" target="_blank"><img src="https://imgur.com/ENbaWUu.png" width="64" height="64"></a>
2018-03-24 01:49:08 +01:00
<a href="https://chrome.google.com/webstore/detail/bitwarden-free-password-m/nngceckbapebfimnlniiiahkandclblb" target="_blank"><img src="https://imgur.com/EuDp4vP.png" width="64" height="64"></a>
2018-03-24 01:50:25 +01:00
<a href="https://brave.com/" target="_blank"><img src="https://imgur.com/z8yjLZ2.png" width="64" height="64"></a>
2017-04-01 05:51:34 +02:00
<a href="https://addons.mozilla.org/firefox/addon/bitwarden-password-manager/" target="_blank"><img src="https://imgur.com/uhb8M86.png" width="64" height="64"></a>
2016-09-11 06:22:18 +02:00
2018-04-14 15:46:57 +02:00
The Bitwarden browser extension is written using the Web Extension API and Angular.
2016-09-11 06:22:18 +02:00
![Alt text](https://i.imgur.com/EmGMZX1.png "My Vault")
2016-12-24 06:13:36 +01:00
# Build/Run
**Requirements**
2018-04-14 15:46:57 +02:00
- [Node.js](https://nodejs.org) v8.11 or greater
2018-04-23 19:49:38 +02:00
- [Gulp](https://gulpjs.com/) (`npm install --global gulp-cli`)
2016-12-24 06:13:36 +01:00
- Chrome (preferred), Opera, or Firefox browser
2018-02-27 19:37:57 +01:00
**Run the app**
2017-11-10 04:51:13 +01:00
2018-02-27 19:37:57 +01:00
```
npm install
2018-04-11 03:54:20 +02:00
npm run build:watch
```
2016-12-24 06:13:36 +01:00
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)
2017-11-16 17:25:43 +01:00
3. Click the "Load unpacked extension" button, navigate to the `build` folder of your local extension instance, and click "Ok".
2016-12-24 06:13:36 +01:00
- Firefox
1. Type `about:debugging` in your address bar to bring up the add-ons page.
2017-11-16 17:25:43 +01:00
2. Click the `Load Temporary Add-on` button, navigate to the `build/manifest.json` file, and "Open".
2016-12-24 06:13:36 +01:00
2016-09-11 06:22:18 +02:00
# Contribute
2017-10-26 17:57:42 +02:00
Code contributions are welcome! Please commit any pull requests against the `master` branch. Learn more about how to contribute by reading the [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
2016-09-11 06:22:18 +02:00
2017-05-19 19:27:57 +02:00
Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature. You can read our security policy in the [`SECURITY.md`](SECURITY.md) file.