Skip to content

Commit

Permalink
docs: add notice and link to migration guide
Browse files Browse the repository at this point in the history
  • Loading branch information
targos authored Jul 4, 2024
1 parent 11cd428 commit deb36ca
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Shared ESLint config for projects using React.

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

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

## Usage

### In JavaScript projects

Create a `eslint.config.mjs` file with the following contents:

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

You can then customize the config for your project.

### In TypeScript projects

See https://github.com/cheminfo/eslint-config/tree/main?tab=readme-ov-file#typescript-and-react

## References

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

0 comments on commit deb36ca

Please sign in to comment.