vectorvesper 0.3.2 → 0.3.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 +78 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
BANNER: host a wide image (≈1280×640) at an ABSOLUTE url — relative paths do
|
|
3
|
+
NOT render on npmjs.com — then uncomment this block:
|
|
4
|
+
|
|
5
|
+
<p align="center">
|
|
6
|
+
<a href="https://vectorvesper.dev">
|
|
7
|
+
<img src="https://vectorvesper.dev/banner.png" alt="Vector Vesper" width="100%" />
|
|
8
|
+
</a>
|
|
9
|
+
</p>
|
|
10
|
+
-->
|
|
11
|
+
|
|
12
|
+
<h1 align="center">Vector Vesper</h1>
|
|
13
|
+
|
|
14
|
+
<p align="center">
|
|
15
|
+
Production-grade WebGL, 3D, and motion components for React. Copy directly into your codebase and own the code.
|
|
16
|
+
</p>
|
|
17
|
+
|
|
18
|
+
<p align="center">
|
|
19
|
+
<a href="https://www.npmjs.com/package/vectorvesper"><img src="https://img.shields.io/npm/v/vectorvesper?color=7EACB5&label=npm" alt="npm version" /></a>
|
|
20
|
+
<a href="https://www.npmjs.com/package/vectorvesper"><img src="https://img.shields.io/npm/dm/vectorvesper?color=7EACB5&label=downloads" alt="downloads" /></a>
|
|
21
|
+
<a href="https://github.com/vectorvesper/vv-components/blob/main/LICENSE"><img src="https://img.shields.io/github/license/vectorvesper/vv-components?color=7EACB5&label=license" alt="license" /></a>
|
|
22
|
+
<a href="https://vectorvesper.dev"><img src="https://img.shields.io/badge/docs-vectorvesper.dev-7EACB5" alt="docs" /></a>
|
|
23
|
+
</p>
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
**Vector Vesper** is a motion toolkit for React consisting of 3D animations, shaders, and advanced motion components.
|
|
28
|
+
|
|
29
|
+
The CLI writes the component code directly into your repository. You have full control over the math, the shaders, and the styles.
|
|
30
|
+
|
|
31
|
+
## Quick Start
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
# Initialize project configuration
|
|
35
|
+
npx vectorvesper init
|
|
36
|
+
|
|
37
|
+
# Add a visual component
|
|
38
|
+
npx vectorvesper add video-card
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
The CLI auto-detects your workspace, installs required animation dependencies (such as `three`, `@react-three/fiber`, or `gsap`), and writes the code to `@/components/vv/`.
|
|
42
|
+
|
|
43
|
+
```tsx
|
|
44
|
+
import { VideoCard } from "@/components/vv/video-card";
|
|
45
|
+
|
|
46
|
+
export default function Page() {
|
|
47
|
+
return (
|
|
48
|
+
<div className="h-screen w-full">
|
|
49
|
+
<VideoCard src="/clip.mp4" />
|
|
50
|
+
</div>
|
|
51
|
+
);
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## CLI Command Reference
|
|
56
|
+
|
|
57
|
+
| Command | Description |
|
|
58
|
+
| --- | --- |
|
|
59
|
+
| `init` | Detect project setup and write `vv.config.json` |
|
|
60
|
+
| `add <slug>` | Add a component and auto-install its dependencies |
|
|
61
|
+
| `list` | List all available components in the registry |
|
|
62
|
+
| `update [slug]` | Update installed components to the latest version |
|
|
63
|
+
| `diff [slug]` | Check local files against registry updates |
|
|
64
|
+
| `remove <slug>` | Safely remove a component's files from the project |
|
|
65
|
+
| `info` | Output workspace diagnostics for troubleshooting |
|
|
66
|
+
|
|
67
|
+
Works out of the box with **npm, pnpm, yarn, and bun** by checking your lockfile.
|
|
68
|
+
|
|
69
|
+
## Links
|
|
70
|
+
|
|
71
|
+
* **Documentation & Guides:** [vectorvesper.dev/docs](https://vectorvesper.dev/docs)
|
|
72
|
+
* **Visual Component Catalog:** [vectorvesper.dev/components](https://vectorvesper.dev/components)
|
|
73
|
+
* **GitHub Repository:** [github.com/vectorvesper/vv-components](https://github.com/vectorvesper/vv-components)
|
|
74
|
+
* **Report Issues:** [github.com/vectorvesper/vv-components/issues](https://github.com/vectorvesper/vv-components/issues)
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
Licensed under the MIT License for open-source components. Premium/commercial components are subject to the Vector Vesper terms of service.
|