Skip to content

Commit deb36ca

Browse files
authored
docs: add notice and link to migration guide
1 parent 11cd428 commit deb36ca

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Shared ESLint config for projects using React.
44

5+
> [!IMPORTANT]
6+
> Configs now require to use the ESLint Flat Config format.
7+
> See the [migration guide](https://github.com/cheminfo/eslint-config/blob/main/MIGRATION.md) for more information.
8+
59
## Installation
610

711
```console
@@ -10,6 +14,8 @@ npm i -D eslint-config-cheminfo-react eslint@^8.57.0
1014

1115
## Usage
1216

17+
### In JavaScript projects
18+
1319
Create a `eslint.config.mjs` file with the following contents:
1420

1521
```js
@@ -20,6 +26,10 @@ export default [...react];
2026

2127
You can then customize the config for your project.
2228

29+
### In TypeScript projects
30+
31+
See https://github.com/cheminfo/eslint-config/tree/main?tab=readme-ov-file#typescript-and-react
32+
2333
## References
2434

2535
This config extends our base [`eslint-config-cheminfo`](https://github.com/cheminfo/eslint-config) JavaScript config.

0 commit comments

Comments
 (0)