Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kanongil committed Nov 8, 2015
1 parent 6468c7e commit 283ed23
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Expand Up @@ -146,9 +146,9 @@ type based on filename extension.:

- `path` - the file path.
- `options` - optional settings:
- `baseDir` - serve file relative to this directory and returns `403 Forbidden` if the
`path` resolves outside the `baseDir`.
Defaults to `true` which uses the `relativeTo` route option as the `baseDir`.
- `confine` - serve file relative to this directory and returns `403 Forbidden` if the
`path` resolves outside the `confine` directory.
Defaults to `true` which uses the `relativeTo` route option as the `confine`.
Set to `false` to disable this security feature.
- `filename` - an optional filename to specify if sending a 'Content-Disposition' header,
defaults to the basename of `path`
Expand Down Expand Up @@ -182,9 +182,9 @@ Generates a static file endpoint for serving a single file. `file` can be set to
file path.
- an object with one or more of the following options:
- `path` - a path string or function as described above (required).
- `baseDir` - serve file relative to this directory and returns `403 Forbidden` if the
`path` resolves outside the `baseDir`.
Defaults to `true` which uses the `relativeTo` route option as the `baseDir`.
- `confine` - serve file relative to this directory and returns `403 Forbidden` if the
`path` resolves outside the `confine` directory.
Defaults to `true` which uses the `relativeTo` route option as the `confine`.
Set to `false` to disable this security feature.
- `filename` - an optional filename to specify if sending a 'Content-Disposition'
header, defaults to the basename of `path`
Expand Down

0 comments on commit 283ed23

Please sign in to comment.