Skip to content

Commit

Permalink
readme and fuckit env
Browse files Browse the repository at this point in the history
  • Loading branch information
nsjames committed Sep 28, 2019
1 parent 82d6918 commit 6bc3232
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 10 deletions.
1 change: 1 addition & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
WEB_HOST=http://localhost:8081/
1 change: 0 additions & 1 deletion .env.example

This file was deleted.

1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ selenium-debug.log

dist/
release/
.env
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)


0 comments on commit 6bc3232

Please sign in to comment.