# eslint-plugin-fast-experiences

Custom rules used within People Experiences

## Installation

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

```sh
npm i eslint --save-dev
```

Next, install `eslint-plugin-fast-experiences`:

```sh
npm install eslint-plugin-fast-experiences --save-dev
```

## Usage

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

```json
{
    "plugins": [
        "fast-experiences"
    ]
}
```


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

```json
{
    "rules": {
        "fast-experiences/rule-name": 2
    }
}
```

## Supported Rules

* Fill in provided rules here