@voltenworks/shipui 0.1.0 → 0.1.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 +21 -21
- package/dist/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,71 +1,71 @@
|
|
|
1
|
-
# shipui
|
|
1
|
+
# @voltenworks/shipui
|
|
2
2
|
|
|
3
3
|
Install [ShipUI](https://voltenworks.com/shipui) components into your project. Base components are free. Premium theme styling requires a theme purchase.
|
|
4
4
|
|
|
5
5
|
## Quick Start
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npx shipui add button
|
|
8
|
+
npx @voltenworks/shipui add button
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Commands
|
|
12
12
|
|
|
13
|
-
### `npx shipui add <name>`
|
|
13
|
+
### `npx @voltenworks/shipui add <name>`
|
|
14
14
|
|
|
15
15
|
Install a base component (free, no auth required).
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
|
-
npx shipui add button
|
|
19
|
-
npx shipui add badge
|
|
20
|
-
npx shipui add card
|
|
18
|
+
npx @voltenworks/shipui add button
|
|
19
|
+
npx @voltenworks/shipui add badge
|
|
20
|
+
npx @voltenworks/shipui add card
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
### `npx shipui add <name> --theme <slug>`
|
|
23
|
+
### `npx @voltenworks/shipui add <name> --theme <slug>`
|
|
24
24
|
|
|
25
25
|
Install a component with premium theme styling.
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
|
-
npx shipui add button --theme aloha
|
|
29
|
-
npx shipui add card --theme retro
|
|
28
|
+
npx @voltenworks/shipui add button --theme aloha
|
|
29
|
+
npx @voltenworks/shipui add card --theme retro
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Free themes (like Candy) don't require auth. Paid themes require a purchase token via `shipui login`.
|
|
32
|
+
Free themes (like Candy) don't require auth. Paid themes require a purchase token via `npx @voltenworks/shipui login`.
|
|
33
33
|
|
|
34
|
-
### `npx shipui list`
|
|
34
|
+
### `npx @voltenworks/shipui list`
|
|
35
35
|
|
|
36
36
|
List available components and themes.
|
|
37
37
|
|
|
38
38
|
```bash
|
|
39
|
-
npx shipui list
|
|
40
|
-
npx shipui list --theme aloha
|
|
41
|
-
npx shipui list --category ui
|
|
42
|
-
npx shipui list --free
|
|
39
|
+
npx @voltenworks/shipui list
|
|
40
|
+
npx @voltenworks/shipui list --theme aloha
|
|
41
|
+
npx @voltenworks/shipui list --category ui
|
|
42
|
+
npx @voltenworks/shipui list --free
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
### `npx shipui login`
|
|
45
|
+
### `npx @voltenworks/shipui login`
|
|
46
46
|
|
|
47
47
|
Authenticate with your purchase token (from your purchase confirmation email).
|
|
48
48
|
|
|
49
49
|
```bash
|
|
50
|
-
npx shipui login
|
|
50
|
+
npx @voltenworks/shipui login
|
|
51
51
|
```
|
|
52
52
|
|
|
53
53
|
Tokens are stored in `~/.config/shipui/config.json` and persist across all projects.
|
|
54
54
|
|
|
55
|
-
### `npx shipui init`
|
|
55
|
+
### `npx @voltenworks/shipui init`
|
|
56
56
|
|
|
57
57
|
Create a `shipui.json` config file for your project. Optional, sensible defaults are used without it.
|
|
58
58
|
|
|
59
59
|
```bash
|
|
60
|
-
npx shipui init
|
|
60
|
+
npx @voltenworks/shipui init
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
### `npx shipui info <name>`
|
|
63
|
+
### `npx @voltenworks/shipui info <name>`
|
|
64
64
|
|
|
65
65
|
Show component details, available themes, and install commands.
|
|
66
66
|
|
|
67
67
|
```bash
|
|
68
|
-
npx shipui info button
|
|
68
|
+
npx @voltenworks/shipui info button
|
|
69
69
|
```
|
|
70
70
|
|
|
71
71
|
## Configuration
|
package/dist/index.js
CHANGED
|
@@ -9,7 +9,7 @@ const program = new Command();
|
|
|
9
9
|
program
|
|
10
10
|
.name('shipui')
|
|
11
11
|
.description('Install ShipUI components into your project')
|
|
12
|
-
.version('0.1.
|
|
12
|
+
.version('0.1.1');
|
|
13
13
|
program.addCommand(addCommand);
|
|
14
14
|
program.addCommand(listCommand);
|
|
15
15
|
program.addCommand(loginCommand);
|