Add flat config example to README (fixes #31)

ArnaudBarre · Dec 2, 2023 · 9594a20 · 9594a20
1 parent f55d0d2
commit 9594a20
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,24 @@ npm i -D eslint-plugin-react-refresh
 }
 ```
 
+### Flat config
+
+```js
+import reactRefresh from "eslint-plugin-react-refresh";
+
+export default [
+  {
+    // in main config for TSX/JSX source files
+    plugins: {
+      "react-refresh": reactRefresh,
+    },
+    rules: {
+      "react-refresh/only-export-components": "warn",
+    },
+  },
+];
+```
+
 ## Fail
 
 ```jsx