From fa27b120e85a8e717cee4458bcbee4c9f2e5dbfb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc-Aur=C3=A8le=20DARCHE?=
 <madarche@users.noreply.github.com>
Date: Thu, 26 Mar 2020 18:02:30 +0100
Subject: [PATCH] Detail explicitly middleware's options in README

---
 README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c649683..ffadd00 100644
--- a/README.md
+++ b/README.md
@@ -84,11 +84,20 @@ should match the following interface:
  * Your custom token resolver
  * @this The ctx object passed to the middleware
  *
- * @param  {object}      opts The middleware's options
+ * @param  {Object}      opts The middleware's options
  * @return {String|null}      The resolved token or null if not found
  */
 ```
 
+opts, the middleware's options:
+
+* getToken
+* secret
+* key
+* isRevoked
+* passthrough
+* debug
+
 The resolution order for the token is the following. The first non-empty token resolved will be the one that is verified.
 
 * `opts.getToken` function.