Skip to content

Commit d3e15f2

Browse files
committed
Rebrand library as part of new Forge design system
1 parent 4bd6a0a commit d3e15f2

File tree

4 files changed

+44
-19
lines changed

4 files changed

+44
-19
lines changed

.github/workflows/cdn-deploy.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,4 @@ jobs:
6262
- name: Sync files to S3 bucket
6363
run: |
6464
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"

.storybook/preview-head.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
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">

README.md

+38-12
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,55 @@
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).
24

35
## Installation
46

5-
Add scoped package registry to `.npmrc` file
7+
### NPM
8+
9+
Set the scoped package registry in your `.npmrc` file:
610
```bash
711
registry=https://registry.npmjs.org/
812
@zigurous:registry=https://npm.pkg.github.com
913
```
1014

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">
1840
```
1941
2042
## Usage
2143
2244
```jsx
45+
import { Button } from '@zigurous/forge-react'
2346
import React from 'react'
24-
import { ExampleComponent } from '@zigurous/react-components'
2547
26-
function Example() {
27-
return <ExampleComponent />
48+
export default function Component() {
49+
return (
50+
<div>
51+
<Button>Example</Button>
52+
</div>
53+
)
2854
}
2955
```

package.json

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"name": "@zigurous/react-components",
3-
"version": "3.0.0",
2+
"name": "@zigurous/forge-react",
3+
"version": "1.0.0",
44
"license": "SEE LICENSE IN LICENSE",
5-
"repository": "https://github.com/zigurous/react-components",
5+
"repository": "https://github.com/zigurous/forge-react",
66
"source": "src/index.ts",
7-
"main": "dist/index.js",
7+
"main": "dist/index.min.js",
88
"module": "dist/index.modern.js",
99
"unpkg": "dist/index.umd.js",
1010
"dependencies": {
@@ -36,7 +36,6 @@
3636
"vite": "^5.4.10"
3737
},
3838
"peerDependencies": {
39-
"@zigurous/css-styles": "^3.0.0",
4039
"react": "^18.1.0",
4140
"react-dom": "^18.1.0"
4241
},

0 commit comments

Comments
 (0)