uikki 1.0.0 → 1.0.1
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 +38 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Uikki✦Uikki CLI 🐒
|
|
2
|
+
|
|
3
|
+
The official CLI tool for **[Uikki✦Uikki](https://comp-plus-seven.vercel.app)**, a Zero-dependency React UI Component Gallery.
|
|
4
|
+
|
|
5
|
+
*(Note: Please replace the Vercel URL above with your actual live URL if it is different)*
|
|
6
|
+
|
|
7
|
+
## 🚀 What is Uikki?
|
|
8
|
+
|
|
9
|
+
Uikki is a collection of beautiful, pre-built React components inspired by the philosophy of `shadcn/ui`. Instead of installing a heavy npm package and using components as a black box, Uikki CLI allows you to **fetch the raw component source code** directly into your project's `src/components/...` directory.
|
|
10
|
+
|
|
11
|
+
You get total control over the code, allowing you to customize it exactly how you want it!
|
|
12
|
+
|
|
13
|
+
## ⚡ Quick Start
|
|
14
|
+
|
|
15
|
+
Run the following command in your React/Tailwind project to add a component:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx uikki add <component-name>
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
**Example:**
|
|
22
|
+
```bash
|
|
23
|
+
npx uikki add button
|
|
24
|
+
npx uikki add drawer
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
The CLI will automatically download the component from the Uikki GitHub repository and save it to your `src/components/ui/` folder.
|
|
28
|
+
|
|
29
|
+
## 🎨 Features
|
|
30
|
+
|
|
31
|
+
- **Zero-dependency:** Animations and logic are built using pure React state and Tailwind CSS. No Framer Motion, no heavy dependencies!
|
|
32
|
+
- **Dark Mode Ready:** All components include Tailwind v4 `dark:` variants out of the box.
|
|
33
|
+
- **Copy & Paste Philosophy:** The code belongs to you. Tweak styles, add logic, and make it yours.
|
|
34
|
+
|
|
35
|
+
## 🔗 Links
|
|
36
|
+
|
|
37
|
+
- **Component Gallery & Playground:** [Uikki✦Uikki Website](https://comp-plus-seven.vercel.app)
|
|
38
|
+
- **GitHub Repository:** [dmswl6310/Uikki-uikki](https://github.com/dmswl6310/Uikki-uikki)
|