Skip to content

Commit 5bc571d

Browse files
aladdin-addljharb
authored andcommitted
[readme] remove global usage and eslint version from readme
1 parent 2145e29 commit 5bc571d

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
1313
* [`hook-use-state`]: Allow UPPERCASE setState setter prefixes ([#3244][] @duncanbeevers)
1414
* `propTypes`: add `VFC` to react generic type param map ([#3230][] @dlech)
1515

16+
### Changed
17+
* [readme] remove global usage and eslint version from readme ([#3254][] @aladdin-add)
18+
19+
[#3254]: https://github.com/yannickcr/eslint-plugin-react/pull/3254
1620
[#3251]: https://github.com/yannickcr/eslint-plugin-react/pull/3251
1721
[#3244]: https://github.com/yannickcr/eslint-plugin-react/pull/3244
1822
[#3235]: https://github.com/yannickcr/eslint-plugin-react/pull/3235

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,11 @@ React specific linting rules for `eslint`
77

88
# Installation
99

10-
Install [`eslint`](https://www.github.com/eslint/eslint) either locally or globally. (Note that locally, per project, is strongly preferred)
11-
1210
```sh
13-
$ npm install eslint@7 --save-dev
11+
$ npm install eslint eslint-plugin-react --save-dev
1412
```
1513

16-
If you installed `eslint` globally, you have to install the React plugin globally too. Otherwise, install it locally (strongly preferred)
17-
18-
```sh
19-
$ npm install eslint-plugin-react --save-dev
20-
```
14+
It is also possible to install ESLint globally rather than locally (using npm install eslint --global). However, this is not recommended, and any plugins or shareable configs that you use must be installed locally in either case.
2115

2216
# Configuration
2317

0 commit comments

Comments
 (0)