eslint-plugin-opinionated/README.md

Opinionated rules for styling your code.

# eslint-plugin-opinionated [![NPM][npm-img]][npm-url] [![Coverage][cov-img]][cov-url]

Opinionated rules for styling your code.

## Table of Contents

*   [Installation](#installation)
*   [Documentation](#documentation)
*   [Code of Conduct](#code-of-conduct)
*   [Contributing](#contributing)
*   [License](#license)

## Installation

**npm**

```bash
npm install eslint-plugin-opinionated
```

**yarn**

```bash
yarn add eslint-plugin-opinionated
```

## Documentation

Add the following to your [ESLint configuration file][eslint-config-url]:

```js
{
  "extends": ["plugin:opinionated/recommended"],
  "plugins": ["opinionated"]
}
```

## Code of Conduct

Please see the [code of conduct](CODE_OF_CONDUCT.md).

## Contributing

Please see the [contributing guide](CONTRIBUTING.md).

## License

[MIT](LICENSE.md)

[cov-img]: https://img.shields.io/codecov/c/github/dogma-io/eslint-plugin-opinionated.svg "Code Coverage"
[cov-url]: https://codecov.io/gh/dogma-io/eslint-plugin-opinionated

[eslint-config-url]: https://eslint.org/docs/user-guide/configuring

[npm-img]: https://img.shields.io/npm/v/eslint-plugin-opinionated.svg "NPM Version"
[npm-url]: https://www.npmjs.com/package/eslint-plugin-opinionated