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