README.md

   1 # Byone Chrome Extension
   2 Byone Chrome Extension wallet is a UTXO base Wallet. The extension in charge of the all the Key and Account Management.
   3
   4 ## Building locally
   5
   6 - Install [Node.js](https://nodejs.org) version 8 and the latest available npm@6
   7 - Install dependencies: `npm install`
   8 - build for production with minification && crx package with `npm run build`
   9 - Optionally, to rebuild on file changes, run `npm run dev`.
  10 - To package .zip files for distribution, run `npm run zip`, or run the full build & zip with `gulp dist`.
  11
  12  Uncompressed builds can be found in `/dist`, compressed builds can be found in `/builds` once they're built.
  13
  14
  15 ## Architecture
  16
  17 ![Architecture Diagram](./doc/architecture-diagram.png)
  18
  19 ## Development
  20
  21 ```bash
  22 npm install
  23 npm run dev
  24 ```
  25
  26 ## Build for Publishing
  27
  28 ```bash
  29 npm run build
  30 ```
  31
  32
  33 ## Other Docs
  34 - [How to add custom build to Chrome](./doc/en/add-to-chrome.md)
  35 - [How to live reload on local dependency changes](./doc/en/developing-on-deps.md)
  36 - [How to use Bytom-JS-SDK and WebAssembly](./doc/en/bytom-js-sdk-webassembly.md)
  37 - [中文文档](./doc/cn/README.md)
  38
  39 ## Thanks to
  40 Many thanks to the early contributors in Bytom-Community.
  41 - [boboyan](https://github.com/boboyan)
  42 - [shijianzhiwai](https://github.com/shijianzhiwai)