eslint-plugin-flow-header/README.md

Check existance of flow header comment.

# eslint-plugin-flow-header

Check existance of flow header comment.

## Installation

You'll first need to install [ESLint](http://eslint.org):

```
$ npm i eslint --save-dev
```

Next, install `eslint-plugin-flow-header`:

```
$ npm install eslint-plugin-flow-header --save-dev
```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-flow-header` globally.

## Usage

Add `flow-header` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json
{
    "plugins": [
        "flow-header"
    ]
}
```


Then configure the rules you want to use under the rules section.

```json
{
    "rules": {
        "flow-header/flow-header": 2
    }
}
```

## Supported Rules

* [flow-header](docs/rules/flow-header.md)