From 3dedd310c64d29f25bbd7ab736f7e075376a4a1e Mon Sep 17 00:00:00 2001 From: Samuel Alev Date: Wed, 20 Dec 2023 11:11:51 +0100 Subject: [PATCH] chore: update README --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 51d948d..fa6a078 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,16 @@ -# Frontify ESLint configuration +# Frontify ESLint configurations This repository contains all Frontify ESLint configurations for its projects. +## Usage + +The configurations are published in 3 different flavors: +- `@frontify/eslint-config-base`: The base configuration including JavaScript and TypeScript rules. +- `@frontify/eslint-config-react`: The base configuration including React rules. +- `@frontify/eslint-config-vue2`: The base configuration plus Vue 2 rules. + +Types aware rules are enabled on all 3 configurations, you will need to define the `tsconfig.json` file in your project and set the path to it in the ESLint Config file ([`parserOptions.project`](https://typescript-eslint.io/packages/parser/#project)). + ## Publish a new version This repository uses [Changeset](https://github.com/changesets/changesets) to generate the changelog file.