Add note to README on path matching

Closes #91.
pillarjs · Oct 3, 2016 · 675bc5b · 675bc5b
1 parent 44c69d5
commit 675bc5b
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/Readme.md b/Readme.md
@@ -40,6 +40,8 @@ var re = pathToRegexp('/foo/:bar', keys)
 // keys = [{ name: 'bar', prefix: '/', delimiter: '/', optional: false, repeat: false, pattern: '[^\\/]+?' }]
 ```
 
+**Please note:** The `RegExp` returned by `path-to-regexp` is intended for use with pathnames or hostnames. It can not handle the query strings or fragments of a URL.
+
 ### Parameters
 
 The path string can be used to define parameters and populate the keys.