From 6446d9483f17ca1c20879db68330a6bd953ea0a2 Mon Sep 17 00:00:00 2001 From: Max Peintner Date: Fri, 3 Jan 2025 14:14:07 +0100 Subject: [PATCH] fix: add missing readme --- packages/zitadel-tailwind-config/README.md | 36 ++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 packages/zitadel-tailwind-config/README.md diff --git a/packages/zitadel-tailwind-config/README.md b/packages/zitadel-tailwind-config/README.md new file mode 100644 index 0000000000..f52b6c263b --- /dev/null +++ b/packages/zitadel-tailwind-config/README.md @@ -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.