@@ -2,41 +2,33 @@
22
33An application for interacting with Azimuth.
44
5−## Install
6−
7−Clone the repo, and use a simple `npm install`.
8−
9−## Build
10−
11−You can use a `npm run build` to create an optimised static build.
12−
135## Usage
146
15−The build directory needs to be served with a static server; you can use the
16−`bridge` script to start serving the site at localhost:5000.
7+From the [latest release][rele]:
178
18−### Ledger support
9+* Download and unzip `bridge-$VERSION.zip`
10+* Open up your command line interface (Terminal on OS X, Command Prompt on
11+ Windows).
12+* Navigate to the `bridge-$VERSION` directory.
13+* Run this command:
1914
20−To authenticate and sign transactions with a Ledger, Bridge must be serving
21−over HTTPS on localhost. This requires self-signed certificates. You can do
22−this via the following:
15+ python3 -m http.server 5000 --bind 127.0.0.1 --directory build
2316
24−* Install [mkcert](https://github.com/FiloSottile/mkcert)
25−* Install a local certificate authority via `mkcert -install`
26−* In your `bridge` directory, generate a certificate valid for localhost via
27− `mkcert localhost`. This will produce two files: `localhost.pem`, the local
28− certificate, and `localhost-key.pem`, its corresponding private key.
29−* Run `python bridge-https.py`
17+* You can then use the Bridge app by navigating to `http://localhost:5000` on
18+ your internet browser.
3019
31−Bridge will serve to localhost over HTTPS on port 4443
20+## Development Notes
21+
22+### Install / Build
3223
33−## Development
24+Clone the repo, and use a simple `npm install`. You can then use a `npm run
25+build` to create an optimised static build (serve it with e.g. [serve][serv]).
3426
3527### General notes
3628
37−Use `npm run pilot` to get going. This will boot up a Ganache node in
38−the background, deploy the Azimuth contracts to it, and fire up a local
39−webserver. Bridge will be served on `localhost:3000`.
29+For devleopment, use `npm run pilot` to get going after a `npm install`. This
30+will boot up a Ganache node in the background, deploy the Azimuth contracts to
31+it, and fire up a local webserver. Bridge will be served on `localhost:3000`.
4032
4133Note that one of our dependencies itself depends on a library called
4234`handle-thing` which breaks under the Ledger support requirements (see below)
@@ -51,6 +43,21 @@ $ nvm use v11.0.0
5143
5244before running `npm run pilot`.
5345
46+### Ledger support
47+
48+To authenticate and sign transactions with a Ledger, Bridge must be serving
49+over HTTPS on localhost. This requires self-signed certificates. You can do
50+this via the following:
51+
52+* Install [mkcert](https://github.com/FiloSottile/mkcert)
53+* Install a local certificate authority via `mkcert -install`
54+* In your `bridge` directory, generate a certificate valid for localhost via
55+ `mkcert localhost`. This will produce two files: `localhost.pem`, the local
56+ certificate, and `localhost-key.pem`, its corresponding private key.
57+* Run `python bridge-https.py`
58+
59+Bridge will serve to localhost over HTTPS on port 4443
60+
5461### Useful Accounts
5562
5663The ecliptic owner is the only account that's able to create galaxies, so
@@ -115,8 +122,9 @@ Additionally you need to run with the `HTTPS` environment variable set to
115122
116123To generate a release `.tar.gz` file, use a simple `npm run release`.
117124
118−This will pack the build directory together with the `bridge` and
119−`bridge-https.py` scripts, and also generate a set of checksums for the build
120−directory. You can verify the checksums on e.g. OS X via `shasum -c
121−checksums.txt`.
125+This will pack the build directory together with the `bridge-https.py` script,
126+and also generate a set of checksums for the build directory. You can verify
127+the checksums on e.g. OS X via `shasum -c checksums.txt`.
122128
129+[rele]: https://github.com/urbit/bridge/releases/latest
130+[serv]: http://npmjs.com/package/serve