nexoreui-cli 0.1.1 → 0.1.3

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 ADDED
@@ -0,0 +1,65 @@
1
+ # NexoreUI CLI 🚀
2
+
3
+ The official CLI tool to scaffold, configure, and install **NexoreUI** components in React, Vite, and Next.js applications with Tailwind CSS v4.
4
+
5
+ [![npm version](https://img.shields.io/npm/v/nexoreui-cli)](https://www.npmjs.com/package/nexoreui-cli)
6
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
7
+
8
+ ---
9
+
10
+ ## ⚡ Quick Start
11
+
12
+ ### 1. Create a New Project from Scratch
13
+ ```bash
14
+ # Interactive project generator with Cyan Theme Studio preset
15
+ npx nexoreui create my-nexore-app --theme cyan --radius 1.0
16
+ ```
17
+
18
+ ### 2. Initialize in an Existing Project
19
+ ```bash
20
+ # Automatically configures nexore.json, @/ path aliases, and @theme CSS tokens
21
+ npx nexoreui init --theme cyan --radius 1.0 -y
22
+ ```
23
+
24
+ ### 3. Add Components
25
+ ```bash
26
+ # Add specific components
27
+ npx nexoreui add button card modal table tabs
28
+
29
+ # Or batch install all 40+ components at once
30
+ npx nexoreui add --all
31
+ ```
32
+
33
+ ---
34
+
35
+ ## 🛠️ Commands
36
+
37
+ | Command | Description | Example |
38
+ | :--- | :--- | :--- |
39
+ | `create [name]` | Scaffolds a complete starter app with Tailwind v4 and NexoreUI | `npx nexoreui create my-app` |
40
+ | `init` | Configures `nexore.json`, `@/*` path alias, and theme tokens | `npx nexoreui init --theme cyan` |
41
+ | `add [components...]` | Adds components to your `src/components/ui/` directory | `npx nexoreui add button modal` |
42
+ | `add --all` | Installs all registered components from the registry | `npx nexoreui add --all` |
43
+ | `list` | Lists all available components in the registry | `npx nexoreui list` |
44
+
45
+ ---
46
+
47
+ ## 🎨 Theme Studio Presets
48
+
49
+ Available color palettes:
50
+ - `cyan` (Default Theme Studio preset: `hsl(190.4 95% 39%)`)
51
+ - `indigo` (`hsl(250 85% 50%)`)
52
+ - `violet` (`hsl(262.1 83.3% 57.8%)`)
53
+ - `emerald` (`hsl(142.1 76.2% 36.3%)`)
54
+ - `rose` (`hsl(346.8 77.2% 49.8%)`)
55
+ - `amber` (`hsl(37.7 92.1% 50.2%)`)
56
+ - `slate` (`hsl(240 5.9% 10%)`)
57
+ - `neon` (`hsl(173 80% 40%)`)
58
+
59
+ Corner Radius values:
60
+ `0`, `0.3`, `0.5`, `0.75`, `1.0` (rem).
61
+
62
+ ---
63
+
64
+ ## 📄 License
65
+ MIT © [NexoreUI](https://nexoreui.site)