File tree 4 files changed +44
-19
lines changed
4 files changed +44
-19
lines changed Original file line number Diff line number Diff line change 62
62
- name : Sync files to S3 bucket
63
63
run : |
64
64
PACKAGE_VERSION=$(npm pkg get version --workspaces=false | tr -d \")
65
- aws s3 sync dist s3://cdn.zigurous.com/react-components @$PACKAGE_VERSION/dist --delete --exclude "*.ts"
65
+ aws s3 sync dist s3://cdn.zigurous.com/forge-react @$PACKAGE_VERSION/dist --delete --exclude "*.ts"
Original file line number Diff line number Diff line change 1
- < link key =" css-styles " rel =" stylesheet " href ="./node_modules/@ zigurous/css-styles /dist/index.min.css " / >
1
+ < link href ="
https://cdn. zigurous.com/[email protected] /dist/index.min.css"
rel =" stylesheet " >
Original file line number Diff line number Diff line change 1
- # @zigurous/react-components
1
+ # Forge React
2
+
3
+ The official React implementation of the Forge design system created by [ @zigurous ] ( https://github.com/zigurous ) .
2
4
3
5
## Installation
4
6
5
- Add scoped package registry to ` .npmrc ` file
7
+ ### NPM
8
+
9
+ Set the scoped package registry in your ` .npmrc ` file:
6
10
``` bash
7
11
registry=https://registry.npmjs.org/
8
12
@zigurous:registry=https://npm.pkg.github.com
9
13
```
10
14
11
- Run one of the following commands in a terminal
12
- ``` bash
13
- npm install @zigurous/react-components
14
- # or
15
- yarn add @zigurous/react-components
16
- # or
17
- pnpm add @zigurous/react-components
15
+ Run one of the following commands in a terminal:
16
+ - Install with npm ` npm install @zigurous/forge-react `
17
+ - Install with yarn ` yarn add @zigurous/forge-react `
18
+ - Install with pnpm ` pnpm add @zigurous/forge-react `
19
+
20
+ ### CDN
21
+
22
+ Add one of the following links to your HTML:
23
+
24
+ #### Cloudfront
25
+
26
+ ``` html
27
+ <
script src =
" https://cdn.zigurous.com/[email protected] /dist/index.min.js" >
28
+ ` ` `
29
+
30
+ #### jsDelivr
31
+
32
+ ` ` ` html
33
+ < script src= " https://cdn.jsdelivr.net/gh/zigurous/[email protected] /dist/index.min.js" >
34
+ ` ` `
35
+
36
+ #### statically
37
+
38
+ ` ` ` html
39
+ < script src= " https://cdn.statically.io/gh/zigurous/forge-react/1.0.0/dist/index.min.js" >
18
40
` ` `
19
41
20
42
## Usage
21
43
22
44
` ` ` jsx
45
+ import { Button } from ' @zigurous/forge-react'
23
46
import React from ' react'
24
- import { ExampleComponent } from ' @zigurous/react-components'
25
47
26
- function Example () {
27
- return < ExampleComponent / >
48
+ export default function Component () {
49
+ return (
50
+ < div>
51
+ < Button> Example< / Button>
52
+ < / div>
53
+ )
28
54
}
29
55
` ` `
Original file line number Diff line number Diff line change 1
1
{
2
- "name" : " @zigurous/react-components " ,
3
- "version" : " 3 .0.0" ,
2
+ "name" : " @zigurous/forge-react " ,
3
+ "version" : " 1 .0.0" ,
4
4
"license" : " SEE LICENSE IN LICENSE" ,
5
- "repository" : " https://github.com/zigurous/react-components " ,
5
+ "repository" : " https://github.com/zigurous/forge-react " ,
6
6
"source" : " src/index.ts" ,
7
- "main" : " dist/index.js" ,
7
+ "main" : " dist/index.min. js" ,
8
8
"module" : " dist/index.modern.js" ,
9
9
"unpkg" : " dist/index.umd.js" ,
10
10
"dependencies" : {
36
36
"vite" : " ^5.4.10"
37
37
},
38
38
"peerDependencies" : {
39
- "@zigurous/css-styles" : " ^3.0.0" ,
40
39
"react" : " ^18.1.0" ,
41
40
"react-dom" : " ^18.1.0"
42
41
},
You can’t perform that action at this time.
0 commit comments