Skip to content

Commit c2583be

Browse files
committed
Update README.md with easier installation instructions
1 parent 9a6fa57 commit c2583be

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,27 +14,30 @@ npm install -D eslint-plugin-proper-tests
1414

1515
## Usage
1616

17-
Add `proper-tests` to the plugins section of your `.eslintrc` configuration file. You
18-
can omit the `eslint-plugin-` prefix:
17+
Use the `recommended` shared config in your `.eslintrc` configuration file:
1918

2019
```js
2120
module.exports = {
22-
"plugins": ["proper-tests"]
21+
"extends": ["plugin:proper-tests/recommended"]
2322
}
2423
```
2524

26-
And then use the `recommended` shared configuration:
25+
and you are good to go. Run ESLint and enjoy the results.
26+
27+
Or, alternatively, add `proper-tests` to the plugins section of your `.eslintrc` configuration file:
2728

2829
```js
2930
module.exports = {
30-
"extends": ["plugin:proper-tests/recommended"]
31+
"plugins": ["proper-tests"],
32+
// ...
3133
}
3234
```
3335

34-
Or configure the rules one by one (not recommended):
36+
and configure the rules one by one:
3537

3638
```js
3739
module.exports = {
40+
"plugins": ["proper-tests"],
3841
"rules": {
3942
"proper-tests/no-useless-matcher-to-be-defined": "error"
4043
}

0 commit comments

Comments
 (0)