From cfc6a9088c9c7a2700a9e78a9080694b463d0242 Mon Sep 17 00:00:00 2001 From: Alexander Early Date: Sat, 28 Mar 2015 17:50:17 -0700 Subject: [PATCH] update docs --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6c495c1..e5af26a 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,12 @@ A library to download and launch Sauce Connect. npm install sauce-connect-launcher ``` +If you wish to also download Sauce Connect at this stage, rather than on first run, use the `SAUCE_CONNECT_DOWNLOAD_ON_INSTALL` environment variable. + +```sh +SAUCE_CONNECT_DOWNLOAD_ON_INSTALL=true npm install +``` + ## Usage @@ -109,7 +115,7 @@ Additional Sauce Connect options not specified above can still be passed. `addi ### Credentials -You can also pass the credentials as `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variables. (reccommended) +You can pass the Sauce Labs credentials as `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variables. (reccommended) You can also create a user.json file in your current working directory with the username and key