Update docs/user-guide/README.md (#195)

* Update docs/user-guide/README.md

* update

Author: ota-meshi

README.md

@@ -50,8 +50,8 @@ and either use the recommended configuration or configure the rules you want:
 
 ### The recommended configuration
 
-The `regexp/recommended` config enables a subset of [the core rules](#white_check_mark-rules) that should be most useful to most users.
-*See https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/configs/recommended.ts for more details.*
+The `plugin:regexp/recommended` config enables a subset of [the rules](#white_check_mark-rules) that should be most useful to most users.
+*See [https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/configs/recommended.ts](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/configs/recommended.ts) for more details.*
 
 ```js
 // .eslintrc.js

docs/user-guide/README.md

@@ -15,30 +15,48 @@ npm install --save-dev eslint eslint-plugin-regexp
 
 ## :book: Usage
 
-### Configuration
+<!--USAGE_SECTION_START-->
 
-Use `.eslintrc.*` file to configure rules. See also: [https://eslint.org/docs/user-guide/configuring](https://eslint.org/docs/user-guide/configuring).
+Add `regexp` to the plugins section of your `.eslintrc` configuration file (you can omit the `eslint-plugin-` prefix)  
+and either use the recommended configuration or configure the rules you want:
 
-Example **.eslintrc.js**:
+### The recommended configuration
+
+The `plugin:regexp/recommended` config enables a subset of [the rules](../rules/README.md) that should be most useful to most users.
+*See [https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/configs/recommended.ts](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/configs/recommended.ts) for more details.*
 
 ```js
+// .eslintrc.js
 module.exports = {
-  extends: [
-    // add more generic rulesets here, such as:
-    // 'eslint:recommended',
-    'plugin:regexp/recommended'
-  ],
-  rules: {
-    // override/add rules settings here, such as:
-    // 'regexp/no-dupe-characters-character-class': 'error'
-  }
+    "plugins": [
+        "regexp"
+    ],
+    "extends": [
+         // add more generic rulesets here, such as:
+         // 'eslint:recommended',
+        "plugin:regexp/recommended"
+    ]
 }
 ```
 
-This plugin provides one config:
+### Advanced Configuration
+
+Override/add specific rules configurations. *See also: [http://eslint.org/docs/user-guide/configuring](http://eslint.org/docs/user-guide/configuring)*.
+
+```js
+// .eslintrc.js
+module.exports = {
+    "plugins": [
+        "regexp"
+    ],
+    "rules": {
+        // Override/add rules settings here, such as:
+        "regexp/rule-name": "error"
+    }
+}
+```
 
-- `plugin:regexp/recommended` ... This is the recommended configuration for this plugin.
-  See [lib/configs/recommended.ts](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/configs/recommended.ts) for details.
+<!--USAGE_SECTION_END-->
 
 See [the rule list](../rules/README.md) to get the `rules` that this plugin provides.
 

tools/update-readme.ts

@@ -52,3 +52,23 @@ fs.writeFileSync(
         )
         .replace(/\n{3,}/gu, "\n\n"),
 )
+
+const userGuideReadmeFilePath = path.resolve(
+    __dirname,
+    "../docs/user-guide/README.md",
+)
+const newUserGuideReadme = fs
+    .readFileSync(userGuideReadmeFilePath, "utf8")
+    .replace(
+        /<!--USAGE_SECTION_START-->[\s\S]*<!--USAGE_SECTION_END-->/u,
+        /<!--USAGE_SECTION_START-->[\s\S]*<!--USAGE_SECTION_END-->/u.exec(
+            newReadme,
+        )![0],
+    )
+
+fs.writeFileSync(
+    userGuideReadmeFilePath,
+    newUserGuideReadme
+        .replace(/\(#white_check_mark-rules\)/g, "(../rules/README.md)")
+        .replace(/\n{3,}/gu, "\n\n"),
+)