Skip to content

Commit

Permalink
Fix minor documentation issues
Browse files Browse the repository at this point in the history
  • Loading branch information
ruiquelhas committed Jul 7, 2016
1 parent 6c22da1 commit 3331d3e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ $ npm install henning
```

## Usage
Register the package as a server plugin to enable validation for each route that parses — `parse: true` — and creates a `Readable` stream for each file in request payload — `output: 'stream'`. For every other route with a different configuration, the validation is skipped.
Register the package as a server plugin to enable validation for each route that parses — `parse: true` — and creates a `Readable` stream for each file in the request payload — `output: 'stream'`. For every other route with a different configuration, the validation is skipped.

If the validation fails, a [joi](https://github.com/hapijs/joi)-like `400 Bad Request` error is returned alongside an additional `content-validation: failure` response header. If everything is ok, the response will ultimately contain a `content-validation: success` header.

Expand All @@ -35,8 +35,8 @@ server.connection({
const plugin = {
register: Henning,
options: {
// Allow png files only
whitelist: ['image/png']
// Allow png files only
whitelist: ['image/png']
}
};

Expand Down

0 comments on commit 3331d3e

Please sign in to comment.