From f28ff933e491ad7b1dd77af6ad3abe126109bd9e Mon Sep 17 00:00:00 2001
From: xlaguna <50924665+xlaguna@users.noreply.github.com>
Date: Tue, 28 May 2019 18:57:59 +0200
Subject: [PATCH] Add information about auth parameter to README (#2166)

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 346f429..2533e8d 100755
--- a/README.md
+++ b/README.md
@@ -304,6 +304,8 @@ These are the available config options for making requests. Only the `url` is re
   // `auth` indicates that HTTP Basic auth should be used, and supplies credentials.
   // This will set an `Authorization` header, overwriting any existing
   // `Authorization` custom headers you have set using `headers`.
+  // Please note that only HTTP Basic auth is configurable through this parameter.
+  // For Bearer tokens and such, use `Authorization` custom headers instead.
   auth: {
     username: 'janedoe',
     password: 's00pers3cret'