@raydenui/ui 0.9.3 → 0.9.4
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 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,13 +15,48 @@ Pixel-perfect components from the [Rayna UI](https://www.raynaui.com/) design sy
|
|
|
15
15
|
[](https://rayden-docs.vercel.app)
|
|
16
16
|
[](https://69b6d5e6cb6bbc778afec0ee-tcxvxzrkrt.chromatic.com/)
|
|
17
17
|
|
|
18
|
-
##
|
|
18
|
+
## Quick Start
|
|
19
|
+
|
|
20
|
+
The fastest way to get started is with `create-rayden-app`:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npx create-rayden-app my-app
|
|
24
|
+
cd my-app
|
|
25
|
+
npm install
|
|
26
|
+
npm run dev
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Templates
|
|
30
|
+
|
|
31
|
+
| Template | Description |
|
|
32
|
+
|----------|-------------|
|
|
33
|
+
| `blank` | Empty project, Rayden UI configured |
|
|
34
|
+
| `minimal` | Demo of core components |
|
|
35
|
+
| `landing` | Hero, features, pricing, CTA |
|
|
36
|
+
| `dashboard` | Sidebar, tables, metrics |
|
|
37
|
+
| `ecommerce` | Products, cart, checkout |
|
|
38
|
+
| `blog` | Articles, categories, posts |
|
|
39
|
+
|
|
40
|
+
### CLI Options
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npx create-rayden-app my-app -f vite -t landing --ts --pm pnpm
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
| Flag | Options |
|
|
47
|
+
|------|---------|
|
|
48
|
+
| `-f, --framework` | `vite` (recommended), `nextjs` |
|
|
49
|
+
| `-t, --template` | `blank`, `minimal`, `landing`, `dashboard`, `ecommerce`, `blog` |
|
|
50
|
+
| `--ts` / `--js` | TypeScript (default) or JavaScript |
|
|
51
|
+
| `--pm` | `npm`, `pnpm`, `yarn` |
|
|
52
|
+
|
|
53
|
+
### Manual Installation
|
|
19
54
|
|
|
20
55
|
```bash
|
|
21
56
|
npm install @raydenui/ui
|
|
22
57
|
```
|
|
23
58
|
|
|
24
|
-
##
|
|
59
|
+
## Usage
|
|
25
60
|
|
|
26
61
|
```tsx
|
|
27
62
|
import "@raydenui/ui/styles.css";
|
|
@@ -54,6 +89,7 @@ function App() {
|
|
|
54
89
|
|
|
55
90
|
- [Documentation](https://rayden-docs.vercel.app) — Full component API and guides
|
|
56
91
|
- [Storybook](https://main--69b6d5d8527b4eddb882e0a7.chromatic.com) — Interactive component explorer
|
|
92
|
+
- [create-rayden-app](https://www.npmjs.com/package/create-rayden-app) — CLI scaffolding with 6 templates
|
|
57
93
|
- [@raydenui/ai](https://www.npmjs.com/package/@raydenui/ai) — MCP server for AI-assisted development
|
|
58
94
|
|
|
59
95
|
## License
|