Updated README.md

README.md

@@ -1,9 +1,8 @@
 # Rudefox Burrow
 
-Rudefox provides a pair of command line tools for the creation and management of Bitcoin wallets.
+*Offline Bitcoin Seed Generation and Wallet Tool*
 
-+ Use `burrow` on an air-gapped single-board computer, like a Raspberry Pi, to generate new seed words, obtain addresses and extended public keys from existing seed words and sign PSBT transactions offline.
-+ Use `reynard` on a connected ("hot") device to view your balance and utxo's and to create new, unsigned transactions.
+Use [Rudefox](https://rudefox.io/) Burrow on an air-gapped, single-board computer, like a Raspberry Pi, to generate new seed words, derive addresses and extended public keys from existing seed words or sign PSBT transactions offline.
 
 ## Unique Feature: ShowMyWork
 
@@ -29,69 +28,38 @@ Input 11 x 8-sided dice rolls [1-8]: 12345678123
 ahead slight scout ahead slight scout ahead slight scout ahead slight scan
 ```
 
-## Menemonic Generation
+## Build Instructions
+
+#### Linux
+
+* Install dependencies: Java 8
 
 ```bash
-alice@cold.machine:~$ burrow mnemonic --interactive --dice-entropy --bits 128
-Input 50 dice rolls [1-6]: 234322343242422344161254151
-Input 23 more dice rolls [1-6]: 33116265515343114314456
-Mnemonic Sentence: mountain tilt wing silk rude fox almost volume wine media verify card
+apt install openjdk-8-jdk
 ```
 
-### Mnemonic Options
+* Clone the repository and build
 
 ```bash
-usage: burrow mnemonic
- -b,--bits <128|160|192|224|256>   bits of entropy (default: 256)
- -d,--dice-entropy                 use dice entropy source
- -e,--events <EVENT_STRING>        string representing events from entropy source
- -h,--help                         display help message
- -i,--interactive                  use interactive command line mode
+bob@hot.machine:~$ git clone https://git.rudefox.io/rudefox/burrow.git
+bob@hot.machine:~$ cd burrow
+bob@hot.machine:~$ ./gradlew build distTar
 ```
 
-## Xpub Export
+* Find the distribution `.tar` file in `build/distributions/`
 
-```bash
-alice@cold.machine:~$ burrow wallet --sentence "stove prefer lunch collect small orphan wasp size beyond auction 
-guilt great" --passphrase apple
-xpub6CKy5SECeJipZid8dF3bopoMGdRzd7hMJuPzMGesZCobrMSssZyASexzXuzRTPVLcqqdyAEZJKPMGvDthgZW2Z3mPHLohxEAVbkvGKAXjqx
-```
-### QR Code Generation
+## Quick Raspbery Pi Install
 
-```bash-qrcode
-alice@cold.machine:~$ burrow wallet --sentence "stove prefer lunch collect small orphan wasp size beyond auction 
-guilt great" --passphrase apple -q
+* Download the latest image [here](https://repo.rudefox.io/service/rest/v1/search/assets/download?sort=version&group=io.rudefox&name=burrow-pi-img&maven.extension=zip)
 
-█▀▀▀▀▀█ ▄█   █▄█ ▀▄▀ ▀▄▄▄██▄  █▀▄ █▀▀▀▀▀█
-█ ███ █ ▀  ▀▄█▄▄▄▄██▄▄▄█  █  █▄   █ ███ █
-█ ▀▀▀ █ █▄▀ █▄█▄▄▄▀█▀▄  ▄▀▀█▀ ▄▄▄ █ ▀▀▀ █
-▀▀▀▀▀▀▀ █▄▀▄█ ▀▄█▄▀ ▀▄█ █ █▄▀▄▀ ▀ ▀▀▀▀▀▀▀
-██ █  ▀█    ███ ██  ▄█▄▀▄▀▀██ █▀▄▄▀▀▀ ▀▀▄
-██ ▀ █▀█▄▀█▄██▀ ▀ █▀ ▄▄▄▀██ █▀▀▀█ █▀  █▀
-█▀█▄  ▀█▀▀ ▄█▄█▄▀ █▀█  ██▀▄█▀ ▄██▀█ ▀   ▀
-▀██   ▀▄▄▀▄ ██ ▀██▄▀▄█▀▀█▄▀▄▀█▀▄▄▀▀█▄▀ █▀
-▀█▄▄ ▀▀▄ ▀▀▀▄▀ ██▄▄ ▀ ▀ █▀ ▀▄▀ █ █ █▀█▄ ▄
-███ █ ▀██ ▀▄▀█ ▄▄▀ ▄ ▄█▄▄ ▀▄██▄ ▀▄█▀▀  ▀▀
-▀█▄█▄ ▀ ▀▄▄█  ▀▄ █ ▄▀▀  ▄▄▀▄█▄█ ██▀▀▀▀▀ █
-▀ ▀▀▄ ▀▄█ ▄  ██▄▀▀██▄▄█▄ ▄█▄   █▀ ▄ ▄▀██
-█ ▀▄▄▄▀█▀██▄▄▀▄▄▀█▄ █ ▄██▀▄  ▄ ▄▄█▀█ █ ▄
-▀ ██ ▀▀▀▄ ▀██▄▄▄ ██  █▀█▀▄█ ▄▄▀▄▀▀ ▄█ ▀█▀
-▀▄▄█ █▀ █▄▀ ██▀█▄ █▄▀████▀▄██ ▄▄▀█ █▀█▀▀█
-▀  ▄▄ ▀▄▄▄▄▀█ ▄▀▀█████  ▀▀▀▄ █ ▄█▀█▀▀█▀▀▀
-▀ ▀▀  ▀▀▄▀▀▄▄▀█▀▄ ▄███ ▀██▀▀█ █▄█▀▀▀█▄ █
-█▀▀▀▀▀█ ▀▄█▄▀ ▄  █ ▀▄▄▄▄▄█▀  ▀▀ █ ▀ █ ▄█▄
-█ ███ █ ▄ █▄ ▄ █▄▄  ▀█  █ ▄ ▀██ █▀█▀█ ▀█▀
-█ ▀▀▀ █ ▄▄▀█ █ ▄ ▄█▄ ▄▄▀█▄▀  ▄█ █ ▀ █▀ █▀
-▀▀▀▀▀▀▀ ▀▀   ▀  ▀    ▀▀   ▀  ▀  ▀▀▀  ▀▀▀
-alice@cold.machine:~$ 
-```
+* Unzip the image file
 
-### Wallet Options
+* Flash it onto an SD Card
+   * [Linux](https://www.raspberrypi.org/documentation/installation/installing-images/linux.md)
+   * [Mac OS](https://www.raspberrypi.org/documentation/installation/installing-images/mac.md)
+   * [Windows](https://www.raspberrypi.org/documentation/installation/installing-images/windows.md)
+   * [Chrome OS](https://www.raspberrypi.org/documentation/installation/installing-images/chromeos.md)
 
-```bash
-usage: burrow wallet
- -h,--help                      display help message
- -p,--passphrase <PASSPHRASE>   optional seed passphrase
- -s,--sentence <SENTENCE>       mnemonic sentence
- -q,--qrcode                    optional seed passphrase
-```
+* Insert the SD card into the Rasberry Pi and power it up
+
+* **IMPORTANT**: Wait for the device to boot and then wait for it to automatically reboot **TWICE** (once to expand the filesystem and again to activate the read-only filesystem)