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 | |
parent | b58ed9e369c92353af6529e4e9e5be591574c36d (diff) | |
download | dexon-wallet-667007ee63945a00fa0c46c3d037a30b1e434bce.tar.gz dexon-wallet-667007ee63945a00fa0c46c3d037a30b1e434bce.tar.zst dexon-wallet-667007ee63945a00fa0c46c3d037a30b1e434bce.zip |
Update documentations
-rw-r--r-- | README.md | 37 | ||||
-rw-r--r-- | docs/README.md | 5 | ||||
-rw-r--r-- | docs/architecture.png | bin | 140227 -> 346328 bytes | |||
-rw-r--r-- | docs/privacy.md | 1 | ||||
-rw-r--r-- | docs/team.md | 78 | ||||
-rw-r--r-- | docs/terms-of-use.md | 1 |
6 files changed, 23 insertions, 99 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 diff --git a/docs/README.md b/docs/README.md index 7868abd1..3b1366ac 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,4 +10,7 @@ - [How to add new networks to the Provider Menu](./adding-new-networks.md) - [How to manage notices that appear when the app starts up](./notices.md) - [How to port DekuSan to a new platform](./porting_to_new_environment.md) -- [How to generate a visualization of this repository's development](./development-visualization.md)
\ No newline at end of file +- [How to generate a visualization of this repository's development](./development-visualization.md) + +- [Privacy Policy](./privacy.md) +- [Terms of Use](./terms-of-use.md) diff --git a/docs/architecture.png b/docs/architecture.png Binary files differindex 2a592482..39f187c8 100644 --- a/docs/architecture.png +++ b/docs/architecture.png diff --git a/docs/privacy.md b/docs/privacy.md new file mode 100644 index 00000000..c6ff6738 --- /dev/null +++ b/docs/privacy.md @@ -0,0 +1 @@ +# DekuSan Privacy Policy
\ No newline at end of file diff --git a/docs/team.md b/docs/team.md deleted file mode 100644 index d406d6ef..00000000 --- a/docs/team.md +++ /dev/null @@ -1,78 +0,0 @@ -# The Team - -Here is an overview of the current DekuSan team, and their primary roles and responsibilities, in the order they joined the team. - -## Core Team Members - -The core team maintains aspects of the main product (the extension) and the core libraries (the DekuSan Controller, provider-engine, etc). - -### Aaron Davis - -@kumavis -Founder / Technical Lead - -Especially in charge of connection to the blockchain. Wrote [provider-engine](https://github.com/DekuSan/provider-engine), and is currently working with @hermanjunge on our JavaScript light-client. - -### Dan Finlay - -@danfinlay -Software Engineer / Product Lead - -Focused on the deliverable, user-valuable aspects of DekuSan, including usability and documentation. Coordinates efforts between different branches of the team, and integrations with other projects. - -### Frankie Pangilinan - -@frankiebee -Software Engineer / Transaction Manager Lead - -Frankie contributes code throughout DekuSan, but has become especially specialized in the way DekuSan manages transactions. She is also the original lead of the [Mascara](https://github.com/DekuSan/mascara) project. - -### Kevin Serrano - -@Zanibas -Software Engineer / Project Management Lead - -Kevin is a software engineer, but also spends a lot of his time keeping the team's administrative operations running smoothly. - -### Thomas Huang - -@tmashuang -QA Engineer - -Thomas is the head of DekuSan Quality Assurance. He both takes the final pass of branches of code before we ship to production, and is also in charge of continuously improving our automated quality assurance process. - -### Christian Jeria - -@cjeria -User Experience Designer - -Christian is the lead of DekuSan's user experience. He is continuously designing prototypes, testing them with users, and refining them with our developers for production. - -### Paul Bouchon - -@bitpshr -Software Engineer - -The newest member of the team! Paul is currently being onboarded, and finding his niche within the team. - -## Laboratory Team Members - -These team members are working on projects that will benefit DekuSan, but are not directly working on the product itself. - -### Herman Junge - -@hermanjunge -Software Engineer - -Herman is currently leading the Mustekala project, a JavaScript, IPFS-based Ethereum light client. - -## Kyokan Team Members - -[Kyokan](http://kyokan.io/) is a consulting firm that has been working closely with the DekuSan team on the latest version of our user interface. Their team members are not members of ConsenSys LLC, but they contribute a lot to the project. - -- Daniel Tsui (@sdsui) -- Chi Kei Chan (@chikeichan) -- Dan Miller (@danjm) -- David Yoo (@yookd) -- Whymarrh Whitby (@whymarrh) - diff --git a/docs/terms-of-use.md b/docs/terms-of-use.md new file mode 100644 index 00000000..4cef36ac --- /dev/null +++ b/docs/terms-of-use.md @@ -0,0 +1 @@ +# Terms of Use
\ No newline at end of file |