fix: add readme

This commit is contained in:
Max Peintner
2025-01-03 14:24:07 +01:00
parent 739c08a19b
commit 4e5a48e8ca

View File

@@ -0,0 +1,36 @@
# ZITADEL Prettier Config
This package provides the Prettier configuration used by ZITADEL projects. It includes a set of formatting rules to ensure consistent code style across all ZITADEL codebases.
## Installation
To install the package, use npm or yarn:
```sh
npm install @zitadel/prettier-config
```
or
```sh
yarn add @zitadel/prettier-config
```
## Usage
To use the Prettier configuration in your project, extend it in your `prettier.config.js` file:
```js
module.exports = {
...require("@zitadel/prettier-config"),
// Add your custom configurations here
};
```
## Documentation
For detailed documentation and configuration options, please refer to the [Prettier documentation](https://prettier.io/docs/en/configuration.html).
## Contributing
Contributions are welcome! Please read the contributing guidelines before getting started.