mirror of
https://github.com/bitwarden/browser.git
synced 2024-09-07 00:58:27 +02:00
Update README.md
This commit is contained in:
parent
881f90bd40
commit
c336436ed3
40
README.md
40
README.md
@ -1 +1,39 @@
|
||||
# desktop
|
||||
[![appveyor build](https://ci.appveyor.com/api/projects/status/github/bitwarden/desktop?branch=master&svg=true)](https://ci.appveyor.com/project/bitwarden/desktop)
|
||||
[![travis build](https://travis-ci.org/bitwarden/desktop.svg?branch=master)](https://travis-ci.org/bitwarden/desktop)
|
||||
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/bitwarden-browser/localized.svg)](https://crowdin.com/project/bitwarden-desktop)
|
||||
[![Join the chat at https://gitter.im/bitwarden/Lobby](https://badges.gitter.im/bitwarden/Lobby.svg)](https://gitter.im/bitwarden/Lobby)
|
||||
|
||||
# Bitwarden Desktop Application
|
||||
|
||||
<img src="https://imgur.com/AexH8Yo.png" width="64" height="64"> <img src="https://imgur.com/8TwwMg2.png" width="64" height="64"> <img src="https://imgur.com/I69xe2a.png" width="64" height="64">
|
||||
|
||||
The Bitwarden desktop app is written using Electron and Angular.
|
||||
|
||||
![My Vault](http://imgur.com/fdhNCJl.png "My Vault")
|
||||
|
||||
# Build/Run
|
||||
|
||||
**Requirements**
|
||||
|
||||
- [Node.js](https://nodejs.org/en/)
|
||||
|
||||
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:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run electron
|
||||
```
|
||||
|
||||
# Contribute
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
Loading…
Reference in New Issue
Block a user