diff --git a/_includes/readmes/serve-index.md b/_includes/readmes/serve-index.md index f720b0d950..3c2febfe0e 100644 --- a/_includes/readmes/serve-index.md +++ b/_includes/readmes/serve-index.md @@ -26,7 +26,7 @@ var serveIndex = require('serve-index') ### serveIndex(path, options) -Returns middlware that serves an index of the directory in the given `path`. +Returns middleware that serves an index of the directory in the given `path`. The `path` is based off the `req.url` value, so a `req.url` of `'/some/dir` with a `path` of `'public'` will look at `'public/some/dir'`. If you are using @@ -148,4 +148,4 @@ are created by/copyright of [FAMFAMFAM](http://www.famfamfam.com/). [downloads-image]: https://img.shields.io/npm/dm/serve-index.svg [downloads-url]: https://npmjs.org/package/serve-index [npm-image]: https://img.shields.io/npm/v/serve-index.svg -[npm-url]: https://npmjs.org/package/serve-index \ No newline at end of file +[npm-url]: https://npmjs.org/package/serve-index