From f9ee3703468c4ae9132b21b01e1a2ee3cebc86e2 Mon Sep 17 00:00:00 2001
From: Jeff Barczewski <jeff.barczewski@gmail.com>
Date: Fri, 10 Jul 2020 11:22:57 -0500
Subject: [PATCH] add to proxy option description in README

---
 README.md | 22 ++++++++++++++++++----
 1 file changed, 18 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 47a8947..b2728ee 100644
--- a/README.md
+++ b/README.md
@@ -244,10 +244,24 @@ waitOn(opts, [cb]) - function which triggers resource checks
   - opts.cert: [ /* strings or binaries */ ],
   - opts.key: [ /* strings or binaries */ ],
   - opts.passphrase: 'yourpassphrase',
-  - opts.auth: { user, pass }
-  - opts.strictSSL: false,
-  - opts.followRedirect: false, // defaults to true
-  - opts.headers: { 'x-custom': 'headers' },
+  - opts.proxy: undefined, false, or object as defined in axios. Default is undefined. If not set axios detects proxy from env vars http_proxy and https_proxy. https://github.com/axios/axios#config-defaults
+
+```js
+  // example proxy object
+  {
+    host: '127.0.0.1',
+    port: 9000,
+    auth: {
+      username: 'mikeymike',
+      password: 'rapunz3l'
+    }
+  }
+```
+
+- opts.auth: { user, pass }
+- opts.strictSSL: false,
+- opts.followRedirect: false, // defaults to true
+- opts.headers: { 'x-custom': 'headers' },
 
 - cb(err) - if err is provided then, resource checks did not succeed