From f88be8b5ad3ea8ae201a52bd7e63e3c782a3f9a3 Mon Sep 17 00:00:00 2001 From: Saugat Acharya Date: Wed, 4 Apr 2018 14:27:14 +0545 Subject: [PATCH] Add installation instructions --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.md b/README.md index 44e20d3..89c2402 100644 --- a/README.md +++ b/README.md @@ -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)