Skip to content

Commit

Permalink
Validator: Add installation instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Fadion Dashi <jonidashi@gmail.com>
  • Loading branch information
fadion committed Mar 20, 2018
1 parent a061723 commit 4c9c0da
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions packages/validator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

A very thin wrapper on top of the fantastic [Joi](https://github.com/hapijs/joi), mostly to provide simpler error handling and validator as middleware. If you know how to use Joi, than you'll feel right at home. Even if you don't, you're minutes away at pumping some awesome validation action.

## Installation

```
$ npm install --save @sapphirejs/validator
```

## Schema

Schemas are plain object literals with the field name as the key and a set of chained functions to declare validation rules. Let's see an example:
Expand Down

0 comments on commit 4c9c0da

Please sign in to comment.