From 3af8eab978f439e7508ce5317bde9c857c028567 Mon Sep 17 00:00:00 2001 From: Adam DeHaven Date: Wed, 5 Jun 2024 11:05:49 -0400 Subject: [PATCH] docs: update readme --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 2f942a9..2d662b4 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,32 @@ # @kong/eslint-config-kong-ui +A [shared ESLint configuration](https://eslint.org/docs/latest/extend/shareable-configs) for Kong's frontend repositories. + +> [!Note] +> This package only supports ESLint flat config files and requires `eslint >= 9.0.0`. +> +> Beginning in ESLint v9.0.0, the default configuration system utilizes a new flat config system. See the [Migration Guide](https://eslint.org/docs/latest/extend/plugin-migration-flat-config) for more information. + +- [Usage](#usage) + - [Installation](#installation) - [Contributing \& Local Development](#contributing--local-development) - [Lint and fix](#lint-and-fix) - [Committing Changes](#committing-changes) - [Package Publishing](#package-publishing) +## Usage + +### Installation + +Install the `@kong/eslint-config-kong-ui` package as a `devDependency` in your host project. + +```sh +pnpm add -D @kong/eslint-config-kong-ui + +# or for a mono repository, install to the workspace root +pnpm add -wD @kong/eslint-config-kong-ui +``` + ## Contributing & Local Development To get started, install the package dependencies