Skip to content

Commit 5d37963

Browse files
committed
docs: update README.md [skip ci]
1 parent 1cad5cd commit 5d37963

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,10 @@ Please also make sure that you have `typescript` and `eslint` installed.
2525

2626
## Usage
2727

28-
Because of the complexity of this config, it is exported as a factory function that takes an options object and returns an ESLint configuration object.
28+
Because of the complexity of the configurations, this package exports several utilities:
2929

30-
This package exports:
31-
32-
- `defineConfigWithVueTs`, a utility function whose type signature is the same as the [`config` function from `typescript-eslint`](https://typescript-eslint.io/packages/typescript-eslint#config), but will modify the given config to work with Vue.js + TypeScript.
33-
- `vueTsConfigs`, contains all the [shared configruations from `typescript-eslint`](https://typescript-eslint.io/users/configs) (in camelCase, e.g. `vueTsConfigs.recommendedTypeChecked`).
30+
- `defineConfigWithVueTs`, a utility function whose type signature is the same as the [`config` function from `typescript-eslint`](https://typescript-eslint.io/packages/typescript-eslint#config), but will modify the given ESLint config to work with Vue.js + TypeScript.
31+
- `vueTsConfigs`, contains all the [shared configruations from `typescript-eslint`](https://typescript-eslint.io/users/configs) (in camelCase, e.g. `vueTsConfigs.recommendedTypeChecked`), and applies to `.vue` files in addition to TypeScript files.
3432
- a Vue-specific config factory: `configureVueProject({ scriptLangs, rootDir })`. More info below.
3533

3634
### Minimal Setup

0 commit comments

Comments
 (0)