tsconfig readme

packages/zitadel-tsconfig/README.md

@@ -0,0 +1,35 @@
+# ZITADEL TypeScript Config
+
+This package provides the TypeScript configuration used by ZITADEL projects. It includes a set of rules and settings to ensure consistent TypeScript configuration across all ZITADEL codebases.
+
+## Installation
+
+To install the package, use npm or yarn:
+
+```sh
+npm install @zitadel/tsconfig
+```
+
+or
+
+```sh
+yarn add @zitadel/tsconfig
+```
+
+## Usage
+
+To use the TypeScript configuration in your project, extend it in your `tsconfig.json` file:
+
+```json
+{
+  "extends": "@zitadel/tsconfig/tsup.json"
+}
+```
+
+## Documentation
+
+For detailed documentation and configuration options, please refer to the [TypeScript documentation](https://www.typescriptlang.org/docs/).
+
+## Contributing
+
+Contributions are welcome! Please read the contributing guidelines before getting started.