From 6bc32323e339097eea5b3725718676cf93ffba10 Mon Sep 17 00:00:00 2001 From: nsjames Date: Sun, 29 Sep 2019 01:33:23 +0300 Subject: [PATCH] readme and fuckit env --- .env | 1 + .env.example | 1 - .gitignore | 1 - README.md | 20 ++++++++++++-------- 4 files changed, 13 insertions(+), 10 deletions(-) create mode 100644 .env delete mode 100644 .env.example diff --git a/.env b/.env new file mode 100644 index 00000000..4d3c2b80 --- /dev/null +++ b/.env @@ -0,0 +1 @@ +WEB_HOST=http://localhost:8081/ \ No newline at end of file diff --git a/.env.example b/.env.example deleted file mode 100644 index e09f9eda..00000000 --- a/.env.example +++ /dev/null @@ -1 +0,0 @@ -WEB_HOST= \ No newline at end of file diff --git a/.gitignore b/.gitignore index 588f813d..02990692 100644 --- a/.gitignore +++ b/.gitignore @@ -18,4 +18,3 @@ selenium-debug.log dist/ release/ -.env diff --git a/README.md b/README.md index 701923ed..14969cdb 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,33 @@ # Scatter Desktop -## Installation +Scatter desktop is a cutting-egde wallet for blockchain as well as a global local-machine authentication provider. -**None of these package are signed yet.** Make sure you only download -Scatter Desktop from this GitHub, and **NOWHERE ELSE**. +## Installation #### [CLICK HERE AND GRAB THE LATEST RELEASE](https://github.com/GetScatter/ScatterDesktop/releases) +Once you have a release build just install it and away you go. + + ### Running in development mode This runs best with `node v10.15.3` and `electron v5.0.1` - clone the repo -- run `yarn install` to install the dependencies. **Important: You can only use yarn to install right now as there's two versions of eosjs being pulled in and only yarn supports aliasing**. -- run `npm start` to start the local server with hot-reloading +- run `yarn install` to install the dependencies. - run `electron .` or `./node_modules/.bin/electron .` from the directory to start electron. +You will also need [ScatterEmbed](https://github.com/GetScatter/ScatterEmbed) running locally as this desktop client simply runs the wallet +software that protects keys and controls encryption. + +Edit the `.env` file to point to your locally running version of Scatter Embed, or leave it as-is to run it with our live version. + + ### Building -- `npm run build` - `npm run release-mac` or `npm run release-windows` or `npm run release-linux` ( you must build from the target machine ) -## Creating Apps for Scatter -### Check out the [Documentation](https://get-scatter.com/docs/examples-interaction-flow)