Skip to content

Commit e666969

Browse files
committed
Update setup instructions
1 parent abf5512 commit e666969

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

README.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,52 @@ You can install `eslint-config-web-scrobbler` by a following way:
1010
> npm install --save-dev eslint-config-web-scrobbler
1111
```
1212

13-
Then, add `eslint-config-web-scrobbler` to the `extends` array in your
14-
`.eslintrc.*` file.
13+
### JavaScript
14+
15+
Add `web-scrobbler` to the `extends` array in your `.eslintrc.*` file:
1516

1617
```json
1718
{
1819
"extends": ["some-other-config-you-use", "web-scrobbler"]
1920
}
2021
```
2122

22-
You can use `web-scrobbler/typescript` config for projects written in TypeScript:
23+
### TypeScript
24+
25+
Install peer dependencies first:
26+
27+
```sh
28+
> npm install --save-dev @typescript-eslint/eslint-plugin @typescript-eslint/parser
29+
```
30+
31+
Then, add `web-scrobbler/typescript` cto the `extends` array in your `.eslintrc.*` file:
32+
2333
```json
2434
{
2535
"extends": ["some-other-config-you-use", "web-scrobbler/typescript"]
2636
}
2737
```
2838

39+
### Vue
40+
41+
Install peer dependencies first:
42+
43+
```sh
44+
> npm install --save-dev eslint-plugin-vue
45+
```
46+
47+
Then, add `web-scrobbler/vue` cto the `extends` array in your `.eslintrc.*` file:
48+
49+
```json
50+
{
51+
"extends": [
52+
"some-other-config-you-use",
53+
"web-scrobbler",
54+
"web-scrobbler/vue"
55+
]
56+
}
57+
```
58+
2959
## License
3060

3161
Licensed under the [MIT License](./LICENSE).

0 commit comments

Comments
 (0)