diff --git a/README.md b/README.md index 631435e7..d7adb741 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,8 @@ Because of the complexity of this config, it is exported as a factory function t This package exports: -- a utility function: `defineConfig`, whose type signature is the same as the [`config` function from `typescript-eslint`](https://typescript-eslint.io/packages/typescript-eslint#config). -- all the [shared configruations from `typescript-eslint`](https://typescript-eslint.io/users/configs), available as named exports (in camelCase, e.g. `recommendedTypeChecked`). +- `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. ### Minimal Setup @@ -40,12 +40,12 @@ This package exports: import pluginVue from 'eslint-plugin-vue' import { defineConfig, - recommended, + configs, } from '@vue/eslint-config-typescript' export default defineConfig( pluginVue.configs['flat/essential'], - recommended, + configs.recommended, ) ``` @@ -60,13 +60,18 @@ All the `