@alignui/cli 0.0.1-alpha.9 → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Doğukan Çavuş
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,33 @@
+<p align="center">
+  <a href="https://alignui.com">
+    <img src="./logo.svg" height="96">
+    <h3 align="center">AlignUI Design System</h3>
+  </a>
+  <p align="center">The Design System You Need</p>
+</p>
+
+[Join the AlignUI Community](https://discord.gg/alignui)
+
+## Introduction
+
+A CLI for adding AlignUI's Tailwind styles to your project.
+
+## Usage
+
+Use the `tailwind` command to initialize tailwind for your project. You need to do this in your project directory and make sure you have installed Tailwind CSS.
+
+> [!CAUTION]
+> This will overwrite your CSS and `tailwind.config` files.
+
+```bash
+npx @alignui/cli tailwind
+```
+
+This command will detect if you're using TypeScript, install the necessary packages, ask for your preferred primary color and color format, and prompt you to choose a prefix for AlignUI's classes if you’d like.
+
+> [!NOTE]  
+> A CSS file with Tailwind directives and a `tailwind.config` file must exist in your project.
+
+## License
+
+[MIT](./LICENSE)