Add information about auth parameter to README (#2166)

axios · May 28, 2019 · f28ff93 · f28ff93
1 parent 5250e6e
commit f28ff93
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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'