Skip to content

Commit f5e7f74

Browse files
authored
docs: add install instructions and note about eslint as dependency (#2)
* docs: add install instructions and note about `eslint` as dependency * docs: remove Github styled alerts * Update README.md
1 parent 9e2e143 commit f5e7f74

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,21 @@
22

33
A drop-in replacement for ESLint 9 featuring multithreaded parallel linting.
44

5-
**IMPORTANT:** Legacy eslintrc configuration is not supported.
5+
> **IMPORTANT:** Legacy `.eslintrc` configuration is not supported.
6+
7+
## Installation
8+
9+
```shell
10+
npm i --save-dev eslint-p
11+
```
12+
13+
```shell
14+
yarn add --dev eslint-p
15+
```
16+
17+
```shell
18+
pnpm add --save-dev eslint-p
19+
```
620

721
## Usage
822

@@ -23,7 +37,21 @@ Valid values for the `--concurrency` option are:
2337
* **`off`**:
2438
No multithreading, run like ESLint. This is not the same as `--concurrency=1`.
2539

26-
Normally, a performance improvement will be only noticeable on systems with 4 or more CPUs.
40+
> Normally, a performance improvement **will be only noticeable on systems with 4 or more CPUs**.
41+
42+
## `ESLint` is installed as a dependency
43+
44+
This package has ESLint set as a dependency, so if you already have `eslint` installed, but with a different version than the one specified in the `package.json` of this package you might get inconsistent results between the CLI and the editor.
45+
46+
To check the version of `ESLint` used by this package you can use:
47+
48+
```shell
49+
npx eslint-p -v
50+
```
51+
52+
To avoid inconsistencies, install the same `eslint` version used by this package or remove the `eslint` dependency from your `package.json`.
53+
54+
[You can find more information on this PR](https://github.com/origin-1/eslint-p/pull/1).
2755

2856
[npm badge]: https://img.shields.io/npm/v/eslint-p?logo=npm
2957
[npm URL]: https://www.npmjs.com/package/eslint-p

0 commit comments

Comments
 (0)