@lottojs/eslint-config/README.md

Simple eslint configuration library.

<a name="readme-top"></a>

<div align="center">

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![NPM][npm-shield]][npm-url]

</div>

<br />
<div align="center">
  <a href="https://github.com/lottojs/eslint-config">
    <img src=".github/logo.png" alt="Logo" width="100" height="115">
  </a>

  <h3 align="center">@lottojs/eslint-config</h3>

  <p align="center">
    Simple eslint configuration library.
    <br />
    <br />
    <a href="https://github.com/lottojs/eslint-config/issues">Report Bug</a>
    ·
    <a href="https://github.com/lottojs/eslint-config/issues">Request Feature</a>
  </p>
</div>


## About The Project

Basic eslint configuration package with common settings in order to help as a base pattern to all [LottoJS](https://github.com/lottojs) projects but nothing excludes it to be also used by the community..

## Documentation
Complete API documentation is available at [lottojs.tech][documentation-url].

## Getting Started

### Installation
   ```sh
    npm i -D eslint @lottojs/eslint-config
   ```
### Usage
Create a `.eslintrc.json` file at the root of your project.
```json
    {
        "extends": [
            "@lottojs/eslint-config/node"
        ]
    }
```

## Contributing

All forms of contributions are more than welcome! You can contribute in the following ways:

- Create an Issue
- Create a Pull Request
- Create third-party middlewares
- Share with your friends
- Make your application with `Lotto`.

For more details, see [Contribution Guide](./CONTRIBUTING.md).

## License

Distributed under the MIT License. See `LICENSE` for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p>


[contributors-shield]: https://img.shields.io/github/contributors/lottojs/eslint-config.svg?style=for-the-badge
[contributors-url]: https://github.com/lottojs/eslint-config/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/lottojs/eslint-config.svg?style=for-the-badge
[forks-url]: https://github.com/lottojs/eslint-config/network/members
[stars-shield]: https://img.shields.io/github/stars/lottojs/eslint-config.svg?style=for-the-badge
[stars-url]: https://github.com/lottojs/eslint-config/stargazers
[issues-shield]: https://img.shields.io/github/issues/lottojs/eslint-config.svg?style=for-the-badge
[issues-url]: https://github.com/lottojs/eslint-config/issues
[license-shield]: https://img.shields.io/github/license/lottojs/eslint-config.svg?style=for-the-badge
[license-url]: https://github.com/lottojs/eslint-config/blob/master/LICENSE.txt
[npm-shield]: https://img.shields.io/npm/v/@lottojs/eslint-config?style=for-the-badge&logo=npm&logoColor=FFFFFF&labelColor=555555&color=CB0001
[npm-url]: https://www.npmjs.com/package/@lottojs/eslint-config
[documentation-url]: https://lottojs.tech