Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adamdehaven committed Jun 5, 2024
1 parent 0672062 commit 3af8eab
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 3af8eab

Please sign in to comment.