# Getting Started

[![npm version](https://img.shields.io/npm/v/eslint-utils.svg)](https://www.npmjs.com/package/eslint-utils)
[![Downloads/month](https://img.shields.io/npm/dm/eslint-utils.svg)](http://www.npmtrends.com/eslint-utils)
[![Build Status](https://travis-ci.org/mysticatea/eslint-utils.svg?branch=master)](https://travis-ci.org/mysticatea/eslint-utils)
[![Coverage Status](https://codecov.io/gh/mysticatea/eslint-utils/branch/master/graph/badge.svg)](https://codecov.io/gh/mysticatea/eslint-utils)
[![Dependency Status](https://david-dm.org/mysticatea/eslint-utils.svg)](https://david-dm.org/mysticatea/eslint-utils)

## 🏁 Goal

`eslint-utils` package provides utility functions and classes for make ESLint custom rules.

## 💿 Installation

Use [npm](https://www.npmjs.com/) or a compatible tool to install.

```
npm install eslint-utils
```

::: tip Requirements
`eslint-utils` requires Node.js `10` or newer versions.
:::

## 📖 Usage

```js
const utils = require("eslint-utils");

// use it to define rules...
```
