diff --git a/README.md b/README.md index 7b0c2cfb..63cf9160 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ This package exports: - `defineConfig`, a utility function whose type signature is the same as the [`config` function from `typescript-eslint`](https://typescript-eslint.io/packages/typescript-eslint#config). - `configs`, contains all the [shared configruations from `typescript-eslint`](https://typescript-eslint.io/users/configs) (in camelCase, e.g. `configs.recommendedTypeChecked`). -- a Vue-specific config factory: `configureVueProject({ supportedScriptLangs, rootDir })`. More info below. +- a Vue-specific config factory: `configureVueProject({ scriptLangs, rootDir })`. More info below. ### Minimal Setup @@ -66,27 +66,27 @@ import { configureVueProject({ // Optional: specify the script langs in `.vue` files - // Defaults to `{ ts: true, js: false, tsx: false, jsx: false }` - supportedScriptLangs: { - ts: true, + // Defaults to `['ts']`. + scriptLangs: [ + 'ts', // [!DISCOURAGED] - // Set to `true` to allow plain `