@exolnet/eslint-config/README.md

ESLint shareable config for eXolnet

# eXolnet's eslint config

[![NPM version](http://img.shields.io/npm/v/eslint-config-exolnet.svg)](https://www.npmjs.org/package/eslint-config-exolnet)
[![Software License](https://img.shields.io/badge/license-MIT-8469ad.svg?style=flat-square)](LICENSE.md)
[![Build Status](https://img.shields.io/travis/eXolnet/eslint-config-exolnet/master.svg?style=flat-square)](https://travis-ci.org/eXolnet/eslint-config-exolnet)

Our base shareable eslint configuration.

## Installation

Install this package, and save it as a `devDependency`:

```
npm install --save-dev eslint-config-exolnet
```

Then have your project's `.eslint.json` file extend the ruleset.

```json
{
    "extends": "eslint-config-exolnet"
}
```

If you're using React in your project, you'll need to extend the React extension of the configuration, and install the eslint React plugin:

```json
{
    "extends": "exolnet/react"
}
```

```
npm install --save-dev eslint-plugin-react
```

If you're using Vue in your project, you'll need to extend the Vue extension of the configuration, and install the eslint Vue and html plugins:

```json
{
    "extends": "exolnet/vue"
}
```

```
npm install --save-dev eslint-plugin-vue eslint-plugin-html
```

If you are using YAML or JavaScript for your [ESLint configuration file format](http://eslint.org/docs/user-guide/configuring#configuration-file-formats) ensure you use the correct syntax for the language used.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE OF CONDUCT](CODE_OF_CONDUCT.md) for details.

## Security

If you discover any security related issues, please email security@exolnet.com instead of using the issue tracker.

## Credits

- [Simon Gaudreau](https://github.com/Gandhi11)
- [All Contributors](../../contributors)

## License

This code is licensed under the [MIT license](http://choosealicense.com/licenses/mit/). 
Please see the [license file](LICENSE) for more information.