Add note about path-to-regexp.

ZijianHe · Nov 25, 2015 · f1b01d6 · f1b01d6
1 parent faab16d
commit f1b01d6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -174,6 +174,9 @@ router.get('/:category/:title', function (ctx, next) {
 });
 ```
 
+The [path-to-regexp](https://github.com/pillarjs/path-to-regexp) module is used
+to convert paths to regular expressions.
+
 **Kind**: instance property of <code>[Router](#exp_module_koa-router--Router)</code>
 
 | Param | Type | Description |

diff --git a/lib/router.js b/lib/router.js
@@ -162,6 +162,9 @@ function Router(opts) {
  * });
  * ```
  *
+ * The [path-to-regexp](https://github.com/pillarjs/path-to-regexp) module is
+ * used to convert paths to regular expressions.
+ *
  * @name get|put|post|patch|delete
  * @memberof module:koa-router.prototype
  * @param {String} path