diff options
author | Hsuan Lee <hsuan@cobinhood.com> | 2018-11-09 10:46:09 +0800 |
---|---|---|
committer | Hsuan Lee <hsuan@cobinhood.com> | 2018-12-10 18:35:41 +0800 |
commit | 667007ee63945a00fa0c46c3d037a30b1e434bce (patch) | |
tree | ef8ea4853c67cb5254279d437055ee7693b41c3b /README.md | |
parent | b58ed9e369c92353af6529e4e9e5be591574c36d (diff) | |
download | dexon-wallet-667007ee63945a00fa0c46c3d037a30b1e434bce.tar.gz dexon-wallet-667007ee63945a00fa0c46c3d037a30b1e434bce.tar.zst dexon-wallet-667007ee63945a00fa0c46c3d037a30b1e434bce.zip |
Update documentations
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 37 |
1 files changed, 17 insertions, 20 deletions
@@ -1,12 +1,10 @@ -# MetaMask Browser Extension -[](https://circleci.com/gh/MetaMask/metamask-extension) [](https://coveralls.io/github/MetaMask/metamask-extension?branch=master) [](https://waffle.io/MetaMask/metamask-extension) - -## Support - -If you're a user seeking support, [here is our support site](https://metamask.zendesk.com/hc/en-us). +# DekuSan Browser Extension +[](https://circleci.com/gh/dexon-foundation/dekusan) ## Introduction +This is forked from [MetaMask](https://github.com/MetaMask/metamask-extension), to work with [DEXON Blocklattice](https://dexon.org) + [Mission Statement](./MISSION.md) [Documentation](https://metamask.github.io/metamask-docs/) @@ -24,25 +22,25 @@ If you're a web dapp developer, we've got two types of guides for you: ### Current Dapp Developers -- If you have a Dapp, and you want to ensure compatibility, [here is our guide on building DekuSan-compatible Dapps](https://github.com/DekuSan/faq/blob/master/DEVELOPERS.md) +- If you have a Dapp, and you want to ensure compatibility, [here is our guide on building DekuSan-compatible Dapps](https://github.com/dexon-foundation/wiki/wiki) ## Building locally -- Install [Node.js](https://nodejs.org) version 8 and the latest available npm@6 - - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you. - - If you install Node.js manually, ensure you're using npm@6 - - Install npm@6 using `npm install -g npm@6` -- Install dependencies: `npm install` -- Install gulp globally with `npm install -g gulp-cli`. -- Build the project to the `./dist/` folder with `gulp build`. -- Optionally, to rebuild on file changes, run `gulp dev`. -- To package .zip files for distribution, run `gulp zip`, or run the full build & zip with `gulp dist`. + - Install [Node.js](https://nodejs.org/en/) version 8.11.3 and npm version 6.1.0 + - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm use` will automatically choose the right node version for you. + - Select npm 6.1.0: ```npm install -g npm@6.1.0``` + - Install yarn: ```npm install -g yarn``` + - Install gulp globally with `npm install -g gulp-cli`. + - Install dependencies: ```yarn``` + - Build the project to the `./dist/` folder with `gulp build`. + - Optionally, to rebuild on file changes, run `gulp dev`. + - To package .zip files for distribution, run `gulp zip`, or run the full build & zip with `gulp dist`. Uncompressed builds can be found in `/dist`, compressed builds can be found in `/builds` once they're built. ## Contributing -You can read [our internal docs here](https://metamask.github.io/metamask-extension/). +You can read [MetaMask internal docs here](https://metamask.github.io/metamask-extension/). You can re-generate the docs locally by running `npm run doc`, and contributors can update the hosted docs by running `npm run publish-docs`. @@ -63,7 +61,7 @@ You can run the linter by itself with `gulp lint`. ## Development ```bash -npm install +yarn npm start ``` @@ -84,7 +82,6 @@ To write tests that will be run in the browser using QUnit, add your test files - [How to develop a live-reloading UI](./docs/ui-dev-mode.md) - [How to add a new translation to DekuSan](./docs/translating-guide.md) - [Publishing Guide](./docs/publishing.md) -- [The DekuSan Team](./docs/team.md) - [How to develop an in-browser mocked UI](./docs/ui-mock-mode.md) - [How to live reload on local dependency changes](./docs/developing-on-deps.md) - [How to add new networks to the Provider Menu](./docs/adding-new-networks.md) @@ -93,4 +90,4 @@ To write tests that will be run in the browser using QUnit, add your test files - [How to use the TREZOR emulator](./docs/trezor-emulator.md) - [How to generate a visualization of this repository's development](./docs/development-visualization.md) -[1]: http://www.nomnoml.com/#view/%5B%3Cactor%3Euser%5D%0A%0A%5Bmetamask-ui%7C%0A%20%20%20%5Btools%7C%0A%20%20%20%20%20react%0A%20%20%20%20%20redux%0A%20%20%20%20%20thunk%0A%20%20%20%20%20ethUtils%0A%20%20%20%20%20jazzicon%0A%20%20%20%5D%0A%20%20%20%5Bcomponents%7C%0A%20%20%20%20%20app%0A%20%20%20%20%20account-detail%0A%20%20%20%20%20accounts%0A%20%20%20%20%20locked-screen%0A%20%20%20%20%20restore-vault%0A%20%20%20%20%20identicon%0A%20%20%20%20%20config%0A%20%20%20%20%20info%0A%20%20%20%5D%0A%20%20%20%5Breducers%7C%0A%20%20%20%20%20app%0A%20%20%20%20%20metamask%0A%20%20%20%20%20identities%0A%20%20%20%5D%0A%20%20%20%5Bactions%7C%0A%20%20%20%20%20%5BaccountManager%5D%0A%20%20%20%5D%0A%20%20%20%5Bcomponents%5D%3A-%3E%5Bactions%5D%0A%20%20%20%5Bactions%5D%3A-%3E%5Breducers%5D%0A%20%20%20%5Breducers%5D%3A-%3E%5Bcomponents%5D%0A%5D%0A%0A%5Bweb%20dapp%7C%0A%20%20%5Bui%20code%5D%0A%20%20%5Bweb3%5D%0A%20%20%5Bmetamask-inpage%5D%0A%20%20%0A%20%20%5B%3Cactor%3Eui%20developer%5D%0A%20%20%5Bui%20developer%5D-%3E%5Bui%20code%5D%0A%20%20%5Bui%20code%5D%3C-%3E%5Bweb3%5D%0A%20%20%5Bweb3%5D%3C-%3E%5Bmetamask-inpage%5D%0A%5D%0A%0A%5Bmetamask-background%7C%0A%20%20%5Bprovider-engine%5D%0A%20%20%5Bhooked%20wallet%20subprovider%5D%0A%20%20%5Bid%20store%5D%0A%20%20%0A%20%20%5Bprovider-engine%5D%3C-%3E%5Bhooked%20wallet%20subprovider%5D%0A%20%20%5Bhooked%20wallet%20subprovider%5D%3C-%3E%5Bid%20store%5D%0A%20%20%5Bconfig%20manager%7C%0A%20%20%20%20%5Brpc%20configuration%5D%0A%20%20%20%20%5Bencrypted%20keys%5D%0A%20%20%20%20%5Bwallet%20nicknames%5D%0A%20%20%5D%0A%20%20%0A%20%20%5Bprovider-engine%5D%3C-%5Bconfig%20manager%5D%0A%20%20%5Bid%20store%5D%3C-%3E%5Bconfig%20manager%5D%0A%5D%0A%0A%5Buser%5D%3C-%3E%5Bmetamask-ui%5D%0A%0A%5Buser%5D%3C%3A--%3A%3E%5Bweb%20dapp%5D%0A%0A%5Bmetamask-contentscript%7C%0A%20%20%5Bplugin%20restart%20detector%5D%0A%20%20%5Brpc%20passthrough%5D%0A%5D%0A%0A%5Brpc%20%7C%0A%20%20%5Bethereum%20blockchain%20%7C%0A%20%20%20%20%5Bcontracts%5D%0A%20%20%20%20%5Baccounts%5D%0A%20%20%5D%0A%5D%0A%0A%5Bweb%20dapp%5D%3C%3A--%3A%3E%5Bmetamask-contentscript%5D%0A%5Bmetamask-contentscript%5D%3C-%3E%5Bmetamask-background%5D%0A%5Bmetamask-background%5D%3C-%3E%5Bmetamask-ui%5D%0A%5Bmetamask-background%5D%3C-%3E%5Brpc%5D%0A +[1]: http://www.nomnoml.com/#view/%5B%3Cactor%3Euser%5D%0A%0A%5Bdekusan-ui%7C%0A%20%20%20%5Btools%7C%0A%20%20%20%20%20react%0A%20%20%20%20%20redux%0A%20%20%20%20%20thunk%0A%20%20%20%20%20ethUtils%0A%20%20%20%20%20jazzicon%0A%20%20%20%5D%0A%20%20%20%5Bcomponents%7C%0A%20%20%20%20%20app%0A%20%20%20%20%20account-detail%0A%20%20%20%20%20accounts%0A%20%20%20%20%20locked-screen%0A%20%20%20%20%20restore-vault%0A%20%20%20%20%20identicon%0A%20%20%20%20%20config%0A%20%20%20%20%20info%0A%20%20%20%5D%0A%20%20%20%5Breducers%7C%0A%20%20%20%20%20app%0A%20%20%20%20%20dekusan%0A%20%20%20%20%20identities%0A%20%20%20%5D%0A%20%20%20%5Bactions%7C%0A%20%20%20%20%20%5BaccountManager%5D%0A%20%20%20%5D%0A%20%20%20%5Bcomponents%5D%3A-%3E%5Bactions%5D%0A%20%20%20%5Bactions%5D%3A-%3E%5Breducers%5D%0A%20%20%20%5Breducers%5D%3A-%3E%5Bcomponents%5D%0A%5D%0A%0A%5Bweb%20dapp%7C%0A%20%20%5Bui%20code%5D%0A%20%20%5Bweb3%5D%0A%20%20%5Bdekusan-inpage%5D%0A%20%20%0A%20%20%5B%3Cactor%3Eui%20developer%5D%0A%20%20%5Bui%20developer%5D-%3E%5Bui%20code%5D%0A%20%20%5Bui%20code%5D%3C-%3E%5Bweb3%5D%0A%20%20%5Bweb3%5D%3C-%3E%5Bdekusan-inpage%5D%0A%5D%0A%0A%5Bdekusan-background%7C%0A%20%20%5Bprovider-engine%5D%0A%20%20%5Bhooked%20wallet%20subprovider%5D%0A%20%20%5Bid%20store%5D%0A%20%20%0A%20%20%5Bprovider-engine%5D%3C-%3E%5Bhooked%20wallet%20subprovider%5D%0A%20%20%5Bhooked%20wallet%20subprovider%5D%3C-%3E%5Bid%20store%5D%0A%20%20%5Bconfig%20manager%7C%0A%20%20%20%20%5Brpc%20configuration%5D%0A%20%20%20%20%5Bencrypted%20keys%5D%0A%20%20%20%20%5Bwallet%20nicknames%5D%0A%20%20%5D%0A%20%20%0A%20%20%5Bprovider-engine%5D%3C-%5Bconfig%20manager%5D%0A%20%20%5Bid%20store%5D%3C-%3E%5Bconfig%20manager%5D%0A%5D%0A%0A%5Buser%5D%3C-%3E%5Bdekusan-ui%5D%0A%0A%5Buser%5D%3C%3A--%3A%3E%5Bweb%20dapp%5D%0A%0A%5Bdekusan-contentscript%7C%0A%20%20%5Bplugin%20restart%20detector%5D%0A%20%20%5Brpc%20passthrough%5D%0A%5D%0A%0A%5Brpc%20%7C%0A%20%20%5Bethereum%20blockchain%20%7C%0A%20%20%20%20%5Bcontracts%5D%0A%20%20%20%20%5Baccounts%5D%0A%20%20%5D%0A%5D%0A%0A%5Bweb%20dapp%5D%3C%3A--%3A%3E%5Bdekusan-contentscript%5D%0A%5Bdekusan-contentscript%5D%3C-%3E%5Bdekusan-background%5D%0A%5Bdekusan-background%5D%3C-%3E%5Bdekusan-ui%5D%0A%5Bdekusan-background%5D%3C-%3E%5Brpc%5D%0A |