From 83570fe97d7095eb583e7ab687bc17777fd3a3b8 Mon Sep 17 00:00:00 2001
From: Douglas Christopher Wilson <doug@somethingdoug.com>
Date: Tue, 24 Jan 2017 23:29:38 -0500
Subject: [PATCH] docs: provide better jsdoc for main function

---
 index.js | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/index.js b/index.js
index ad57fbd..214ca4b 100644
--- a/index.js
+++ b/index.js
@@ -25,13 +25,12 @@ var onHeaders = require('on-headers')
 module.exports = timeout
 
 /**
- * Timeout:
+ * Create a new timeout middleware.
  *
- * See README.md for documentation.
- *
- * @param {Number} time
- * @param {Object} options
- * @return {Function} middleware
+ * @param {number|string} time The timeout as a number of milliseconds or a string for `ms`
+ * @param {object} [options] Additional options for middleware
+ * @param {boolean} [options.respond=true] Automatically emit error when timeout reached
+ * @return {function} middleware
  * @public
  */