@cfx-dev/eslint-config-ui/README.md

cfx-dev's ESLint config, following our styleguide

# UI Eslint Config
This package provides @cfx-dev eslint shared config.

## Instalation
```console
yarn add -D eslint@^9.28.0 @cfx-dev/eslint-config-ui
```
or
```console
npm install --save-dev eslint@^9.28.0 @cfx-dev/eslint-config-ui
```

## Usage
Add extends to your eslint config file `eslint.config.mjs`:
```javascript
import { defineConfig } from "eslint/config";
import cfxUiConfig from "@cfx-dev/eslint-config-ui";

export default defineConfig([
	{
		files: ["src/**/*{ts,tsx}"],
		extends: [cfxUiConfig],
	},
]);

```

## License
This project is licensed under the MIT License.