Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
VicSolWang committed Nov 14, 2023
1 parent 1eb77c2 commit 78fd038
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@

## :rocket: Usage

Add eslint-config-wzx-vue to the "extends" in your `.eslintrc.* file`.
Starting from v5.x, we will use the new flat eslint config. Add eslint-config-wzx-vue in your `eslint.config.js`.

{
"extends": "wzx-vue"
}
import wzxVue from 'eslint-config-wzx-vue';

export default [
...wzxVue,
]

:bulb: Typescript eslint needs `tsconfig.json` in your project root directory. And the config will select the rules of `vue2` or `vue3` according to the vue version installed in your project.

Expand Down

0 comments on commit 78fd038

Please sign in to comment.