Merge pull request #6 from bycoinio/Dapp-v1.4.0

[bytom/Byone.git] / README.md

diff --git a/README.md b/README.md
index 3ea53fa..df5c787 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,42 @@
-# chrome-extension-wallet
+# Byone Chrome Extension
+Byone Chrome Extension wallet is a UTXO base Wallet. The extension in charge of the all the Key and Account Management.
 
-> Bytom Chrome Extension Wallet
+## Building locally
 
-## Build Setup
+- Install [Node.js](https://nodejs.org) version 8 and the latest available npm@6
+- Install dependencies: `npm install`
+- build for production with minification && crx package with `npm run build`
+- Optionally, to rebuild on file changes, run `npm run dev`.
+- To package .zip files for distribution, run `npm run zip`, or run the full build & zip with `gulp dist`.
 
-``` bash
-# install dependencies
-npm install
+ Uncompressed builds can be found in `/dist`, compressed builds can be found in `/builds` once they're built.
+
+
+## Architecture
+
+![Architecture Diagram](./doc/architecture-diagram.png)
+
+## Development
 
-# serve with auto reload && import the **dist** folder in the Chrome browser
+```bash
+npm install
 npm run dev
+```
+
+## Build for Publishing
 
-# build for production with minification && crx package
+```bash
 npm run build
 ```
 
-## Architecture Diagram
-![png](https://gitee.com/eostimeline/bytom-chrome-extension/raw/master/doc/architecture-diagram.png)
\ No newline at end of file
+
+## Other Docs
+- [How to add custom build to Chrome](./doc/en/add-to-chrome.md)
+- [How to live reload on local dependency changes](./doc/en/developing-on-deps.md)
+- [How to use Bytom-JS-SDK and WebAssembly](./doc/en/bytom-js-sdk-webassembly.md)
+- [中文文档](./doc/cn/README.md)
+
+## Thanks to
+Many thanks to the early contributors in Bytom-Community.
+- [boboyan](https://github.com/boboyan)
+- [shijianzhiwai](https://github.com/shijianzhiwai)