Skip to content

Commit

Permalink
DOC: add more documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
royriojas committed Jun 15, 2016
1 parent 3da648e commit 443d90d
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,30 @@ TODO:
- Add unit tests
- Add better documentation

## Install

```bash
npm i --save mobx mobx-form
```

## Usage

```bash
import { createModel } from 'mobx-form';

createModel({
email: '',
}, {
email: {
fn(field) {
// return true/false
// return Promise.reject({ error: 'some error '}) // will be used as error message
}
}
})

```
## Example:
```javascript
Expand Down

0 comments on commit 443d90d

Please sign in to comment.