Skip to content

Commit 34ec74c

Browse files
committed
docs: simplify README
1 parent f5a69d6 commit 34ec74c

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

+8-11
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,6 @@ More information about **formatting rules** vs **code-quality rules** can be fou
3535

3636
### Installation
3737

38-
`npm@<7` does not automatically install `peerDependencies`, so if that's what you're using, install them manually.
39-
Here is an example, but use it only for reference, because your decisions regarding version ranges and range specifiers may vary.
40-
4138
```sh
4239
npm install --save-dev \
4340
eslint@^8.44.0 \
@@ -47,7 +44,7 @@ npm install --save-dev \
4744
eslint-config-conventions@latest
4845
```
4946

50-
Yes, this is a large number of packages. This is due to [a known limitation in ESLint](https://github.com/eslint/eslint/issues/3458).
47+
This is a large number of packages due to [a known limitation in ESLint](https://github.com/eslint/eslint/issues/3458).
5148

5249
This list of dependencies are:
5350

@@ -63,15 +60,15 @@ If you want to use **TypeScript**, you also need to install:
6360
```sh
6461
npm install --save-dev \
6562
typescript@^5.0.4 \
66-
@typescript-eslint/eslint-plugin@^5.59.5 \
67-
@typescript-eslint/parser@^5.59.5
63+
@typescript-eslint/eslint-plugin@^5.60.1 \
64+
@typescript-eslint/parser@^5.60.1
6865
```
6966

7067
Dependencies are:
7168

7269
- [TypeScript](https://github.com/Microsoft/TypeScript)
73-
- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint); ESLint rules for TypeScript.
74-
- [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint); ESLint parser for TypeScript.
70+
- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint): ESLint rules for TypeScript.
71+
- [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint): ESLint parser for TypeScript.
7572

7673
### Configuration with [Prettier](https://prettier.io/) (recommended)
7774

@@ -82,7 +79,7 @@ npm install --save-dev prettier eslint-config-prettier eslint-plugin-prettier
8279

8380
# Create an empty config file to let editors and other tools know you are using Prettier
8481
# You can personalize it with your own rules
85-
echo {}> .prettierrc.json
82+
echo "{}" > .prettierrc.json
8683
```
8784

8885
#### `.eslintrc.json`
@@ -109,8 +106,8 @@ echo {}> .prettierrc.json
109106
```jsonc
110107
{
111108
"scripts": {
112-
"lint:eslint": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
113-
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\""
109+
"lint:eslint": "eslint . --ignore-path .gitignore",
110+
"lint:prettier": "prettier . --check --ignore-path .gitignore"
114111
}
115112
}
116113
```

0 commit comments

Comments
 (0)