gladvn 0.2.21 → 0.2.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -27
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -23,11 +23,11 @@ Designed with strict architectural principles, `gladvn` is optimized not just fo
|
|
|
23
23
|
## 🚀 Installation
|
|
24
24
|
|
|
25
25
|
> [!WARNING]
|
|
26
|
-
> **Please use `npx` to clone the components into your project
|
|
26
|
+
> **Please use `npx` to clone the components into your project.** Installing via `npm` is no longer supported. Using `npx` gives you full control over the source code and styling, which is the core philosophy and intended way to use this library.
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
We highly recommend using the CLI to initialize components for maximum flexibility.
|
|
29
29
|
|
|
30
|
-
###
|
|
30
|
+
### Installation
|
|
31
31
|
|
|
32
32
|
This approach automatically copies all component source code, hooks, and styles directly into your project. You own the code, you can freely modify it, and the CLI will automatically install necessary peer dependencies for you!
|
|
33
33
|
|
|
@@ -46,31 +46,7 @@ npx gladvn init components/ui
|
|
|
46
46
|
import { Button } from "@/gladvn/components/micro/button";
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
### Option 2: Install as an npm package
|
|
50
49
|
|
|
51
|
-
If you prefer to use the pre-built components without cluttering your repository with source code, install it via npm:
|
|
52
|
-
|
|
53
|
-
```bash
|
|
54
|
-
npm install gladvn
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
**Setup Tailwind CSS v4:**
|
|
58
|
-
Update your main CSS file to scan the library for Tailwind utility classes and import its CSS variables:
|
|
59
|
-
|
|
60
|
-
```css
|
|
61
|
-
@import "tailwindcss";
|
|
62
|
-
|
|
63
|
-
/* 1. Tell Tailwind to scan gladvn for utility classes */
|
|
64
|
-
@source "../node_modules/gladvn/dist";
|
|
65
|
-
|
|
66
|
-
/* 2. Import gladvn global CSS variables */
|
|
67
|
-
@import "gladvn/gladvn.css";
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
**Usage:**
|
|
71
|
-
```tsx
|
|
72
|
-
import { Button, Card, CardHeader, CardTitle, CardContent } from "gladvn";
|
|
73
|
-
```
|
|
74
50
|
|
|
75
51
|
---
|
|
76
52
|
|
package/package.json
CHANGED