Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make clear Joi is module to be required #210

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Make clear Joi is module to be required #210

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ vogels is a [DynamoDB][5] data mapper for [node.js][1].
## Installation

npm install vogels

## Getting Started
First, you need to configure the [AWS SDK][2] with your credentials.

Expand Down Expand Up @@ -53,7 +52,13 @@ Currently the following region codes are available in Amazon:
| us-west-2 | US West (Oregon) |

### Define a Model
Models are defined through the toplevel define method.
The [Joi module](https://github.com/hapijs/joi) is used for defining schemas and needs to be imported:

```
var Joi = require('joi');`
```

Models are defined through the toplevel define method.

```js
var Account = vogels.define('Account', {
Expand Down