Skip to content

Commit

Permalink
Add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mesaugat committed Apr 4, 2018
1 parent 878670f commit f88be8b
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,44 @@
# eslint-config-leapfrog

[![npm version](https://badge.fury.io/js/eslint-config-leapfrog.svg)](https://badge.fury.io/js/eslint-config-leapfrog)
[![downloads](http://img.shields.io/npm/dt/eslint-config-leapfrog.svg)](https://npmjs.org/package/eslint-config-leapfrog)

Set of [ESLint](https://eslint.org/) rules for JavaScript projects at Leapfrog.

**`eslint-config-leapfrog` adds rules on top of `eslint:recommended` and `plugin:react/recommended`.**

## Requires

* ESLint **>= 4.19.0**

## Usage

Add `eslint-config-leapfrog` as a dev dependency.

```bash
yarn add eslint-config-leapfrog --dev
```

Include `eslint-config-leapfrog` in your [.eslintrc](https://eslint.org/docs/user-guide/getting-started#configuration) file.

```json
{
"extends": [
"eslint-config-leapfrog"
]
}
```

For projects using React, include `eslint-config-leapfrog/react` which contains ESLint rules specific to React.

```json
{
"extends": [
"eslint-config-leapfrog/react"
]
}
```

## License

[MIT](LICENSE)

0 comments on commit f88be8b

Please sign in to comment.