diff --git a/README.md b/README.md index 25efecb612..db205cee12 100644 --- a/README.md +++ b/README.md @@ -148,3 +148,18 @@ QmfGBgFe2aqf83Wv21m9k5DH2ew89CDj4tydoxJWdK6NNL 1552 runtime.3d77e510.js QmYPa8jcHH7gfopMALr5XTW4i1QM2xgVBe3NeP11y3tErA - static/ QmeYBC5EgbccC8NEwXC2rvbd93YiHtTM5xYzqCDohXerDf 859984 vendor.8b793a81.js ``` + +## Desktop App + +The main advantage of using Desktop App is that it by default stores encrypted accounts on the filesystem instead of browser's local storage. +Local storage is susceptible to attacks using XSS (Cross-Site Scripting). There's no such risk when with files stored on disk. + +The desktop app uses the [Electron](https://www.electronjs.org/) framework. It provides the same features as web app, the only difference +being different account storage. + +The accounts are stored in the following directories: +* Mac: `~/Library/Application Support/polkadot-apps/polkadot-accounts` +* Linux: `~/.config/polkadot-apps/polkadot-accounts` (or `$XDG_CONFIG_HOME/polkadot-apps/polkadot-accounts` if `$XDG_CONFIG_HOME` is defined) +* Windows: `%APPDATA%\polkadot-apps\polkadot-accounts` + +For more details on the desktop app, head over to [Electron package README](https://github.com/polkadot-js/apps/blob/master/packages/apps-electron/README.md). diff --git a/packages/apps-electron/README.md b/packages/apps-electron/README.md index f71c0dc174..ed7c21aa08 100644 --- a/packages/apps-electron/README.md +++ b/packages/apps-electron/README.md @@ -1,3 +1,17 @@ # @polkadot/apps-electron -WARNING: This is not deemed stable yet for external use. +Desktop Polkadot apps client for Windows, Mac and Linux. + +## Installation + +[Download here](https://github.com/polkadot-js/apps/releases/latest) latest versions for Windows, Mac and Linux. + +## Development and testing + +Contributions are welcome! + +Follow steps described [here](https://github.com/polkadot-js/apps#development) to setup the project. + +* Run `yarn start:electron` to start the app in development mode. You will possibly see the `Not Found / 404` message. It's ok, just wait for the build to finish and refresh pressing `Ctrl+R`. +* Run `yarn test` to run tests +* Run `yarn packElectron:(mac|linux|windows)` with the OS you want to build for to create the app executable. Find the packages in `packages/apps-electron/release`.