From 85c831c6cad3a3ff450ce0b23063f644e0a43c40 Mon Sep 17 00:00:00 2001
From: Max Peintner <peintnerm@gmail.com>
Date: Fri, 3 Jan 2025 14:08:39 +0100
Subject: [PATCH] readme eslint config

---
 packages/zitadel-eslint-config/README.md | 35 ++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 packages/zitadel-eslint-config/README.md

diff --git a/packages/zitadel-eslint-config/README.md b/packages/zitadel-eslint-config/README.md
new file mode 100644
index 0000000000..d8d6851f91
--- /dev/null
+++ b/packages/zitadel-eslint-config/README.md
@@ -0,0 +1,35 @@
+# ZITADEL ESLint Config
+
+This package provides the ESLint configuration used by ZITADEL projects. It includes a set of rules and plugins to ensure consistent code quality and style across all ZITADEL codebases.
+
+## Installation
+
+To install the package, use npm or yarn:
+
+```sh
+npm install @zitadel/eslint-config
+```
+
+or
+
+```sh
+yarn add @zitadel/eslint-config
+```
+
+## Usage
+
+To use the ESLint configuration in your project, extend it in your `.eslintrc` file:
+
+```js
+{
+  "extends": "@zitadel/eslint-config"
+}
+```
+
+## Documentation
+
+For detailed documentation and configuration options, please refer to the [ESLint documentation](https://eslint.org/docs/user-guide/configuring).
+
+## Contributing
+
+Contributions are welcome! Please read the contributing guidelines before getting started.