Merge pull request #1 from bpdavenport/master

Add README for examples directory

Author: bpdavenport

example/README.md

@@ -0,0 +1,18 @@
+BitGoJS Examples
+=======
+
+# Wallet Recovery Tool
+
+The wallet recovery tool allows you to completely recover a BitGo BIP32 multi-sig wallet
+using only the user's 2 keys, without making any communication with BitGo. In the event
+BitGo ceases to operate, or becomes temporarily unavailable, the tool makes it possible
+to exert full control over the bitcoin in your wallet.
+
+To use the tool, you will need the KeyCard from your BitGo wallet, along with your
+wallet passcode. If you provided
+your own backup public key at wallet creation time, you will also need the private half
+of the backup key. It may be necessary to scan the QR codes from the KeyCard 
+with a mobile phone and email the resulting text to yourself.
+
+Run the tool using 'node recoverwallet.js'
+

example/recoverwallet.js

@@ -80,11 +80,11 @@ var collectInputs = function() {
     inputs.nosend = true;
   }
 
-  return getVariable("userKey", "Enter value from Box A: 'User Key':")()
-    .then(getVariable("backupKey", "Enter value from Box B: 'Backup Key':"))
-    .then(getVariable("bitgoKey", "Enter value from Box C: 'BitGo Public Key':"))
-    .then(getVariable("password", "Enter your wallet passcode:"))
-    .then(getVariable("destination", "Enter the bitcoin address to receive the funds:"));
+  return getVariable("userKey", "Enter value from Box A: 'User Key': ")()
+    .then(getVariable("backupKey", "Enter value from Box B: 'Backup Key': "))
+    .then(getVariable("bitgoKey", "Enter value from Box C: 'BitGo Public Key': "))
+    .then(getVariable("password", "Enter your wallet passcode: "))
+    .then(getVariable("destination", "Enter the bitcoin address to receive the funds: "));
 };
 
 //