docs: more consistent wording and better examples

haoqunjiang · haoqunjiang · commit aeefa788e6a9 · 2021-12-23T16:52:35.000+08:00
diff --git a/README.md b/README.md
@@ -1,23 +1,23 @@
 # @vue/eslint-config-typescript
 
-> eslint-config-typescript for vue-cli
+> eslint-config-typescript for Vue
 
 See [@typescript-eslint/eslint-plugin](https://typescript-eslint.io/rules/) for available rules.
 
-This config is specifically designed to be used by Vue CLI & `create-vue` setups
+This config is specifically designed to be used by `@vue/cli` & `create-vue` setups
 and is not meant for outside use (it can be used but some adaptations
 on the user side might be needed - for details see the config file).
 
 A part of its design is that this config may implicitly depend on
-other parts of Vue CLI setups, such as `eslint-plugin-vue` being
+other parts of `@vue/cli`/`create-vue` setups, such as `eslint-plugin-vue` being
 extended in the same resulting config.
 
 ## Installation
 
 In order to work around [a known limitation in ESLint](https://github.com/eslint/eslint/issues/3458), we recommend you to use this package alongside `@rushstack/eslint-patch`, so that you don't have to install too many dependencies:
 
 ```sh
-npm install --dev @vue/eslint-config-typescript @rushstack/eslint-patch
+npm add --dev @vue/eslint-config-typescript @rushstack/eslint-patch
 ```
 
 ## Usage
@@ -33,12 +33,13 @@ So when used alongside other sharable configs, this config should be placed at t
 An example `.eslintrc.cjs`:
 
 ```js
+/* eslint-env node */
 require("@rushstack/eslint-patch/modern-module-resolution")
 
 module.exports = {
   extends: [
-    'plugin:vue/essential',
     'eslint:recommended',
+    'plugin:vue/vue3-essential',
     '@vue/eslint-config-typescript'
   ]
 }
@@ -50,24 +51,25 @@ This is extended from the `@typescript-eslint/recommended` ruleset, which is an
 See the [original documentation](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin/src/configs#recommended) for more information.
 
 Some of its rules, however, might conflict with `prettier`.
-So when used alongside other sharable configs, this config should be placed after all other configs except for the one from `eslint-plugin-prettier` in the `extends` array.
+So when used alongside other sharable configs, this config should be placed after all other configs except for the one from `@vue/eslint-config-prettier` or `eslint-plugin-prettier` in the `extends` array.
 
 An example `.eslintrc.cjs`:
 
 ```js
+/* eslint-env node */
 require("@rushstack/eslint-patch/modern-module-resolution")
 
 module.exports = {
   extends: [
-    'plugin:vue/essential',
+    'plugin:vue/vue3-essential',
     '@vue/eslint-config-typescript/recommended',
-
-    'plugin:prettier/recommended'
+    '@vue/eslint-config-prettier'
   ]
 }
 ```
 
 ### With Other Community Configs
 
-If you are following the [`standard`](https://standardjs.com/) or [`airbnb`](https://github.com/airbnb/javascript/) style guides, don't manually extend from this package.
-Please use `@vue/eslint-config-standard-with-typescript` or `@vue/eslint-config-airbnb-with-typescript` instead.
+Work-In-Progress.
+
+~~If you are following the [`standard`](https://standardjs.com/) or [`airbnb`](https://github.com/airbnb/javascript/) style guides, don't manually extend from this package. Please use `@vue/eslint-config-standard-with-typescript` or `@vue/eslint-config-airbnb-with-typescript` instead.~~
diff --git a/package.json b/package.json
@@ -19,7 +19,9 @@
   },
   "keywords": [
     "vue",
-    "cli"
+    "cli",
+    "eslint",
+    "typescript"
   ],
   "author": "Evan You",
   "license": "MIT",
