on master help sign in
Merge pull request #118 from urbit/readme-updates

Clarify instructions in README

commitcb4ec11d62c3f650bd456bb5992b905d9ef95629 authorJared Tobin <jared@jtobin.io> dateMon 22 Apr 2019, 21:11 (8 years ago) parent644aac65410d08
1 file changed+12−11
README.md+12−11
README.md+12−11
@@ -10,14 +10,16 @@ Python 3.7.2
1010
1111### Instructions
1212
13−To use Bridge:
13+#### Install
1414
15−- [Download a release](https://github.com/urbit/bridge/releases)
16−- Unzip it (`bridge-$version.zip`)
17−- Open up your command line interface (Terminal on MacOS, Command Prompt on Windows)
18−- Follow the instructions below to run Bridge
15+1. [Download a release](https://github.com/urbit/bridge/releases)
16+2. Unzip it (`bridge-$version.zip`)
17+3. Open up your command line interface (Terminal on MacOS, Command Prompt on Windows)
18+4. `cd` into the `bridge-$version` directory
19+
20+Follow the instructions below to run Bridge.
1921
20−#### Running Bridge
22+#### Run Bridge
2123
2224If you plan to authenticate and sign transactions with a Master Ticket, BIP39 mnemonic, Ethereum private key, or keystore file:
2325
@@ -25,17 +27,16 @@ If you plan to authenticate and sign transactions with a Master Ticket, BIP39 mn
25272. Run `python3 -m http.server 5000 --bind 127.0.0.1`
26283. Navigate to http://localhost:5000 using a web browser to access Bridge (we recommend using Firefox or Chrome)
2729
28−#### Running Bridge with Ledger support
30+#### Run Bridge with Ledger support
2931
3032If you plan to authenticate and sign transactions with a [Ledger](https://www.ledger.com/), Bridge must be serving over HTTPS on localhost. This requires self-signed certificates. To do this:
3133
32341. Install [mkcert](https://github.com/FiloSottile/mkcert)
33352. If you're using Firefox, additionally install [nss](https://github.com/nss-dev/nss)
34363. Install a local certificate authority via `mkcert -install`
35−4. `cd` into the `bridge-$version` directory
36−5. Run `mkcert localhost` to generate a certificate valid for localhost. This will produce two files: `localhost.pem`, the local certificate, and `localhost-key.pem`, its corresponding private key
37−6. Run `python bridge-https.py`
38−7. Navigate to https://localhost:4443 in a web browser to access Bridge
37+4. From the `bridge-$version` directory, run `mkcert localhost` to generate a certificate valid for localhost. This will produce two files: `localhost.pem`, the local certificate, and `localhost-key.pem`, its corresponding private key
38+5. Run `python bridge-https.py`
39+6. Navigate to https://localhost:4443 in a web browser to access Bridge
3940
4041### Verify checksums
4142