Skip to content

Commit a17d0e1

Browse files
docs: clarify which packages are for which nuxt version (#324)
1 parent 850cb15 commit a17d0e1

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Nuxt ESLint packages
22

3-
## `@nuxt/eslint-config`
3+
## Nuxt 3: `@nuxt/eslint-config`
44

55
[![npm version][npm-version-src]][npm-version-href]
66
[![npm downloads][npm-downloads-src]][npm-downloads-href]
@@ -46,15 +46,15 @@ You might also want to add a script entry to your `package.json:
4646
}
4747
```
4848

49-
## `@nuxtjs/eslint-config` and `@nuxtjs/eslint-config-typescript`
49+
## Nuxt 2: `@nuxtjs/eslint-config` and `@nuxtjs/eslint-config-typescript`
5050

5151
[![GitHub Actions](https://flat.badgen.net/github/checks/nuxt/eslint-config/main)](https://github.com/nuxt/eslint-config/actions?query=workflow%3Aci)
5252
[![npm](https://flat.badgen.net/npm/dm/@nuxtjs/eslint-config)](https://npmjs.com/package/@nuxtjs/eslint-config)
5353
[![npm (scoped with tag)](https://flat.badgen.net/npm/v/@nuxtjs/eslint-config)](https://npmjs.com/package/@nuxtjs/eslint-config)
5454

5555
> Opinionated [ESlint](https://eslint.org/) configuration used internally by Nuxt projects.
5656
57-
## Usage
57+
### Usage
5858

5959
Do you want to add the config to your own projects? There you go:
6060

@@ -84,7 +84,7 @@ $ yarn add -D eslint
8484
}
8585
```
8686

87-
## Full example
87+
### Full example
8888

8989
A full example `.eslintrc` for a project with babel support:
9090

@@ -101,7 +101,7 @@ A full example `.eslintrc` for a project with babel support:
101101
}
102102
```
103103

104-
## TypeScript
104+
### TypeScript
105105

106106
If you're using TypeScript, follow [Usage](#usage) section by replacing `@nuxtjs/eslint-config` by `@nuxtjs/eslint-config-typescript`.
107107

@@ -116,7 +116,7 @@ And in your `.eslintrc` all you need is :
116116
You can then edit/override same rules as you could with `@nuxtjs/eslint-config` but also TypeScript rules.
117117
You can find the list of supported TypeScript rules [here](https://typescript-eslint.io/rules/#supported-rules) and you can read more about Nuxt's TypeScript support [in the docs](https://nuxt.com/docs/guide/concepts/typescript).
118118

119-
### License
119+
## License
120120

121121
Made with ❤️
122122

0 commit comments

Comments
 (0)