franz-validate/readme.md

validate franz.yml files

# franz-validate [![CircleCI](https://circleci.com/gh/franzsh/franz-validate/tree/master.svg?style=svg)](https://circleci.com/gh/franzsh/franz-validate/tree/master)

> validate franz.yml files


## Install

```
$ npm install --save franz-validate
```


## Usage

```js
const franzValidate = require('franz-validate')

const franzFile = {
  service: {
    port: 3000,
    environment: {
      node: 7
    }
  },
  endpoints: {
    'get-users': {
      url: '/get-users',
      method: 'GET'
    }
  }
}

franzValidate(franzFile)
// => true
```


## API

### franzValidate(franz, [options])

Returns an `boolean`

#### franz

Type: `object`<br/>
Required

franz file object

#### options

Type: `object`

##### docker

Type: `object`<br/>
Default: `false`

`true` if project is using docker.


## License

MIT © [Bu Kinoshita](https://bukinoshita.io)