From 0b41fbd068309d41c75d4b517be7480b90e9fb33 Mon Sep 17 00:00:00 2001
From: Mikl Wolfe <wolfemikl@gmail.com>
Date: Wed, 29 May 2024 09:50:43 -0600
Subject: [PATCH] feat(docs): update readme

---
 README.md | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 69 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index eb963bc..f66adfb 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,83 @@
 # eslint-plugin-disable-autofix
 
 Disable autofix for ESLint rules and prevent them from being formatted without
-having to turn them off
+having to turn them off.
 
 ## Usage
 
 ### Install
 
-```shell
+```sh
 npm i -D eslint-plugin-disable-autofix
 ```
 
 ### Configure
 
+Import and include `disable-autofix` in the `plugins` object
+
+Add prefix `disable-autofix/` to the rule and disable the original
+
+```ts
+import disableAutofix from 'eslint-plugin-disable-autofix';
+
+export default [
+  {
+    plugins: {
+      'disable-autofix': disableAutofix,
+    },
+    rules: {
+      'prefer-const': 'off',
+      'disable-autofix/prefer-const': 'warn',
+    },
+  },
+];
+```
+
+Using 3rd-party Rules
+
+```ts
+import disableAutofix from 'eslint-plugin-disable-autofix';
+import react from 'eslint-plugin-react';
+
+export default [
+  {
+    plugins: {
+      'disable-autofix': disableAutofix,
+      react,
+    },
+    rules: {
+      'react/jsx-indent': 'off',
+      'disable-autofix/react/jsx-indent': 'error',
+    },
+  },
+];
+```
+
+Using Scoped Rules
+
+```ts
+import disableAutofix from 'eslint-plugin-disable-autofix';
+import htmlEslint from '@html-eslint/eslint-plugin';
+
+export default [
+  {
+    plugins: {
+      'disable-autofix': disableAutofix,
+      '@html-eslint': htmlEslint,
+    },
+    rules: {
+      '@html-eslint/require-closing-tags': 'off',
+      'disable-autofix/@html-eslint/require-closing-tags': [
+        'error',
+        { selfClosing: 'always' },
+      ],
+    },
+  },
+];
+```
+
+### Configure Legacy
+
 Include `disable-autofix` in the `eslintrc` plugins array
 
 Add prefix `disable-autofix/` to the rule and disable the original
@@ -27,7 +92,7 @@ module.exports = {
 };
 ```
 
-Use 3rd-party rules
+Using 3rd-party Rules
 
 ```js
 module.exports = {
@@ -39,7 +104,7 @@ module.exports = {
 };
 ```
 
-Use scoped rules
+Using Scoped Rules
 
 ```js
 module.exports = {