@juv/codego-react-ui 1.0.0 → 1.0.2

package/README.md

@@ -1,4 +1,4 @@
-# @juv/codego-ui
+# @juv/codego-react-ui
 
 A collection of reusable React UI components built with Tailwind CSS, Motion, and Lucide icons.
 
@@ -8,20 +8,79 @@ A collection of reusable React UI components built with Tailwind CSS, Motion, an
 
 ---
 
-## Installation
+## Prerequisites
+
+Before installing this package, make sure the following are set up in your project:
+
+### 1. React 18+
+
+```bash
+npm install react react-dom
+```
+
+### 2. Tailwind CSS v4
 
 ```bash
-npm install @juv/codego-ui
+npm install tailwindcss @tailwindcss/vite
 ```
 
-> Requires React >= 18 and Tailwind CSS configured in your project.
+Add the plugin to your `vite.config.ts`:
+
+```ts
+import tailwindcss from "@tailwindcss/vite"
+import { defineConfig } from "vite"
+
+export default defineConfig({
+  plugins: [tailwindcss()],
+})
+```
+
+Then import Tailwind in your main CSS file:
+
+```css
+@import "tailwindcss";
+```
+
+### 3. Lucide React (icons)
+
+```bash
+npm install lucide-react
+```
+
+### 4. Motion (animations)
+
+```bash
+npm install motion
+```
+
+### 5. date-fns (date utilities — required by Calendar, Date Picker, Date Range Picker)
+
+```bash
+npm install date-fns
+```
+
+### 6. tailwind-merge + clsx (utility — used internally)
+
+```bash
+npm install tailwind-merge clsx
+```
+
+---
+
+## Installation
+
+Once all prerequisites are installed:
+
+```bash
+npm install @juv/codego-react-ui
+```
 
 ---
 
 ## Usage
 
 ```tsx
-import { Button, Card, Modal } from "@juv/codego-ui"
+import { Button, Card, Modal } from "@juv/codego-react-ui"
 ```
 
 ---