Skip to content

Commit a397534

Browse files
authored
Update README.md
1 parent bd206c0 commit a397534

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
11
# eslint-plugin-primer-react
22
ESLint rules for Primer React
3+
4+
## Installation
5+
6+
1. Assuming you already have [ESLint](https://www.npmjs.com/package/eslint) installed, run:
7+
8+
```shell
9+
# npm
10+
npm install --save-dev eslint-plugin-primer-react
11+
12+
# yarn
13+
yarn add --dev eslint-plugin-primer-react
14+
```
15+
16+
2. In your [ESLint configuration file](https://eslint.org/docs/user-guide/configuring/configuration-files), extend the recommended Primer React ESLint config:
17+
18+
```js
19+
{
20+
"extends": [
21+
// ...
22+
"plugin:primer-react/recommended"
23+
]
24+
}
25+
```
26+
27+
## Rules
28+
29+
* [no-deprecated-color-variables](#)

0 commit comments

Comments
 (0)