fix: add missing readme

This commit is contained in:
Max Peintner
2025-01-03 14:14:07 +01:00
parent 79e43c21f7
commit 6446d9483f

View File

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