dimaac 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 +23 -48
- package/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,74 +1,49 @@
|
|
|
1
|
-
# DiMaac
|
|
1
|
+
# DiMaac
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Add DiMaac UI components to your projects.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Usage
|
|
6
6
|
|
|
7
|
-
### Option 1: Global Installation (Recommended)
|
|
8
7
|
```bash
|
|
9
|
-
|
|
8
|
+
npx dimaac init
|
|
10
9
|
```
|
|
11
10
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
```
|
|
11
|
+
`init` command initializes a components directory for your project.
|
|
12
|
+
|
|
13
|
+
### add
|
|
16
14
|
|
|
17
|
-
### Option 3: Use with npx (No Installation Required)
|
|
18
15
|
```bash
|
|
19
|
-
npx dimaac
|
|
16
|
+
npx dimaac add [component]
|
|
20
17
|
```
|
|
21
18
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
### Install Components
|
|
19
|
+
Adds a new component to your project.
|
|
25
20
|
|
|
21
|
+
Example:
|
|
26
22
|
```bash
|
|
27
|
-
|
|
28
|
-
dimaac add component MouseTiltCard
|
|
29
|
-
dimaac add component TextScrambleReveal
|
|
30
|
-
dimaac add component SwipeableCards
|
|
31
|
-
|
|
32
|
-
# Local installation
|
|
33
|
-
npx dimaac add component MouseTiltCard
|
|
34
|
-
npm run dimaac add component MouseTiltCard
|
|
35
|
-
|
|
36
|
-
# With npx (no installation)
|
|
37
|
-
npx dimaac-ui-cli add component MouseTiltCard
|
|
38
|
-
|
|
39
|
-
# Components will be installed to ./components/{category}/
|
|
23
|
+
npx dimaac add MouseTiltCard
|
|
40
24
|
```
|
|
41
25
|
|
|
42
|
-
|
|
26
|
+
You can also use the optional `--all` flag to install all components:
|
|
43
27
|
|
|
44
28
|
```bash
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
dimaac add example TextScrambleRevealDemo
|
|
48
|
-
dimaac add example SwipeableCardsDemo
|
|
49
|
-
|
|
50
|
-
# Local installation
|
|
51
|
-
npx dimaac add example MouseTiltCardDemo
|
|
52
|
-
npm run dimaac add example MouseTiltCardDemo
|
|
29
|
+
npx dimaac add --all
|
|
30
|
+
```
|
|
53
31
|
|
|
54
|
-
|
|
55
|
-
npx dimaac-ui-cli add example MouseTiltCardDemo
|
|
32
|
+
You can install the related demos / examples for the related components by using the `-e` flag with the add command:
|
|
56
33
|
|
|
57
|
-
|
|
34
|
+
```bash
|
|
35
|
+
npx dimaac add [component] -e
|
|
58
36
|
```
|
|
59
37
|
|
|
60
|
-
|
|
61
|
-
|
|
38
|
+
Example:
|
|
62
39
|
```bash
|
|
63
|
-
|
|
64
|
-
|
|
40
|
+
npx dimaac add MouseTiltCard -e
|
|
41
|
+
```
|
|
65
42
|
|
|
66
|
-
|
|
67
|
-
npx dimaac list
|
|
68
|
-
npm run dimaac list
|
|
43
|
+
To check all the available components, you can use the add without supplying anything extra:
|
|
69
44
|
|
|
70
|
-
|
|
71
|
-
npx dimaac
|
|
45
|
+
```bash
|
|
46
|
+
npx dimaac add
|
|
72
47
|
```
|
|
73
48
|
|
|
74
49
|
## Available Components
|
package/index.js
CHANGED
|
@@ -10,7 +10,7 @@ const GITHUB_RAW_BASE = 'https://raw.githubusercontent.com/Hank-D-Tank/dimaac-ui
|
|
|
10
10
|
program
|
|
11
11
|
.name('dimaac')
|
|
12
12
|
.description('Add DiMaac UI components to your projects')
|
|
13
|
-
.version('1.0.
|
|
13
|
+
.version('1.0.1');
|
|
14
14
|
|
|
15
15
|
const componentCategories = {
|
|
16
16
|
'reveals': ['TextScrambleReveal', 'LiquidImageReveal'],
|