Update docs

access-watch · Aug 18, 2016 · 18676c6 · 18676c6
1 parent dff4af0
commit 18676c6
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 node_modules/
 .nyc_output/
 coverage/
+npm-debug.log
diff --git a/api.md b/api.md
@@ -147,7 +147,9 @@ Remove an item from cache can also be named `del`
 <a name="AccessWatch.fwdHeaders"></a>
 
 ### AccessWatch.fwdHeaders : <code>AccessWatch.ForwardHeaders</code>
-The standard headers that a reverse proxy should set.
+The standard headers that a reverse proxy should set. This means that
+forwarded request should set the headers `X-Forwarded-For`,
+`X-Forwarded-Proto`, and the first entry of `X-Forwarded-For`
 
 **Kind**: static property of <code>[AccessWatch](#AccessWatch)</code>  
 <a name="AccessWatch.ForwardedHeaders"></a>

diff --git a/index.js b/index.js
@@ -269,7 +269,9 @@ class AccessWatch {
 }
 
 /**
- * The standard headers that a reverse proxy should set.
+ * The standard headers that a reverse proxy should set. This means that
+ * forwarded request should set the headers `X-Forwarded-For`,
+ * `X-Forwarded-Proto`, and the first entry of `X-Forwarded-For`
  *
  * @type {AccessWatch.ForwardHeaders}
  */