Skip to content

Commit 1baeadb

Browse files
authored
Update README (#8)
* Add Overview * Update Peer dependencies * Update Usage
1 parent 110b3e1 commit 1baeadb

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,25 @@
55

66
Recommended ESLint Shareable Config for TypeScript
77

8+
## Overview
9+
10+
`@eslint-recommended/eslint-config-typescript` is using following configurations.
11+
12+
- [eslint-config-standard-with-typescript](https://www.npmjs.com/package/eslint-config-standard-with-typescript)
13+
- [eslint-plugin-unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn)'s recommended
14+
- [eslint-plugin-eslint-comments](https://www.npmjs.com/package/eslint-plugin-eslint-comments)'s recommended
15+
816
## Peer dependencies
917

18+
- [@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)
1019
- [eslint](https://www.npmjs.com/package/eslint)
1120
- [eslint-config-standard-with-typescript](https://www.npmjs.com/package/eslint-config-standard-with-typescript)
1221
- [eslint-plugin-eslint-comments](https://www.npmjs.com/package/eslint-plugin-eslint-comments)
1322
- [eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import)
1423
- [eslint-plugin-n](https://www.npmjs.com/package/eslint-plugin-n)
1524
- [eslint-plugin-promise](https://www.npmjs.com/package/eslint-plugin-promise)
1625
- [eslint-plugin-unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn)
17-
- [@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)
26+
- [typescript](https://www.npmjs.com/package/typescript)
1827

1928
## Usage
2029

@@ -34,14 +43,15 @@ Install `@eslint-recommended/eslint-config-typescript` and its peer dependencies
3443

3544
```sh
3645
npm i -D \
46+
@typescript-eslint/eslint-plugin \
3747
eslint \
3848
eslint-config-standard-with-typescript \
3949
eslint-plugin-eslint-comments \
4050
eslint-plugin-import \
4151
eslint-plugin-n \
4252
eslint-plugin-promise \
4353
eslint-plugin-unicorn \
44-
@typescript-eslint/eslint-plugin \
54+
typescript \
4555
@eslint-recommended/eslint-config-typescript
4656
```
4757

0 commit comments

Comments
 (0)