Skip to content

Commit

Permalink
Add install docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Skelton committed Jan 20, 2022
1 parent 73134fc commit 1f79178
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,29 @@
[![changesets](https://img.shields.io/badge/maintained%20with-changesets-blue)](https://github.com/atlassian/changesets)

Widen's shared ESLint config and plugins.

## Installation

```sh
yarn add -D eslint eslint-{config,plugin}-widen eslint-plugin-sort @babel/{core,eslint-parser}

# If you use TypeScript
yarn add -D @typescript-eslint/{eslint-plugin,parser}

# If you use React
yarn add -D eslint-plugin-{react,react-hooks,jsx-a11y}

# If you use Jest
yarn add -D eslint-plugin-jest
```

## Usage

In your `.eslintrc` file, add the following four entries to your extends list.
If you don't need a specific configuration, simply remove it from the list.

```json
{
"extends": ["widen", "widen/typescript", "widen/react", "widen/jest"]
}
```

0 comments on commit 1f79178

Please sign in to comment.