mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-13 21:36:03 +00:00
fix: add readme
This commit is contained in:
36
packages/zitadel-prettier-config/README.md
Normal file
36
packages/zitadel-prettier-config/README.md
Normal 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.
|
Reference in New Issue
Block a user