update docs, get environment from shell

bencxr · bencxr · commit ae29fcf6c708 · 2015-04-10T09:50:32.000-07:00
Summary: update docs on starting bitgoexpress get bitgo environment from shell variable BITGO_ENV put an example browser.html to show how to include sdk into browser side app Reviewers: ryan Reviewed By: ryan Subscribers: ben Differential Revision: https://phabricator.bitgo.com/D886
diff --git a/README.md b/README.md
@@ -27,7 +27,7 @@ Suitable for developers working in a language without an official BitGo SDK.
 BitGo Express runs as a service in your own datacenter, and handles the client-side operations involving your own keys, such as partially signing transactions before submitting to BitGo.
 This ensures your keys never leave your network, and are not seen by BitGo. BitGo Express can also proxy the standard BitGo REST APIs, providing a unified interface to BitGo through a single REST API.
 
-`bin/bitgo-express`
+`bin/bitgo-express [-h] [-v] [-p PORT] [-b BIND] [-e ENV] [-d] [-k KEYPATH] [-c CRTPATH]`
 
 # Compile
 
diff --git a/browser.html b/browser.html
@@ -0,0 +1,8 @@
+<html>
+<head>
+</head>
+<body>
+<!-- This file should get generated when you do npm run-script compile-dbg --> 
+<script src="BitGoJS.js"></script>
+</body>
+</html>
diff --git a/src/bitgo.js b/src/bitgo.js
@@ -114,7 +114,7 @@ var BitGo = function(params) {
       throw new Error('invalid environment');
     }
   } else {
-    params.env = 'test';
+    params.env = process.env.BITGO_ENV || 'test';
   }
   this.env = params.env;
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,8 @@ @@
 +<html>
 +<head>
 +</head>
 +<body>
 +<!-- This file should get generated when you do npm run-script compile-dbg -->
 +<script src="BitGoJS.js"></script>
 +</body>
 +</html>
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ var BitGo = function(params) {`
`114`	`114`	`throw new Error('invalid environment');`
`115`	`115`	`}`
`116`	`116`	`} else {`
`117`		`- params.env = 'test';`
	`117`	`+ params.env = process.env.BITGO_ENV \|\| 'test';`
`118`	`118`	`}`
`119`	`119`	`this.env = params.env;`
`120`	`120`