Skip to content

Commit c93d40f

Browse files
committed
Rebrand library as part of new Forge design system
1 parent 5b7b4ed commit c93d40f

File tree

3 files changed

+37
-16
lines changed

3 files changed

+37
-16
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/css-styles@$PACKAGE_VERSION/dist --delete
65+
aws s3 sync dist s3://cdn.zigurous.com/forge-css@$PACKAGE_VERSION/dist --delete

README.md

+33-12
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,45 @@
1-
# @zigurous/css-styles
1+
# Forge CSS
2+
3+
The official CSS 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/css-styles
14-
# or
15-
yarn add @zigurous/css-styles
16-
# or
17-
pnpm add @zigurous/css-styles
15+
Run one of the following commands in a terminal:
16+
- Install with npm `npm install @zigurous/forge-css`
17+
- Install with yarn `yarn add @zigurous/forge-css`
18+
- Install with pnpm `pnpm add @zigurous/forge-css`
19+
20+
Import the css file in your code:
21+
```js
22+
import '@zigurous/forge-css/dist/index.min.css'
23+
```
24+
25+
### CDN
26+
27+
Add one of the following links to your HTML:
28+
29+
#### Cloudfront
30+
31+
```html
32+
<link href="https://cdn.zigurous.com/[email protected]/dist/index.min.css" rel="stylesheet">
33+
```
34+
35+
#### jsDelivr
36+
37+
```html
38+
<link href="https://cdn.jsdelivr.net/gh/zigurous/[email protected]/dist/index.min.css" rel="stylesheet">
1839
```
1940

20-
## Usage
41+
#### statically
2142

22-
```jsx
23-
import '@zigurous/css-styles/dist/index.min.css'
43+
```html
44+
<link href="https://cdn.statically.io/gh/zigurous/forge-css/1.0.0/dist/index.min.css" rel="stylesheet">
2445
```

package.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"name": "@zigurous/css-styles",
3-
"version": "3.0.0",
2+
"name": "@zigurous/forge-css",
3+
"version": "1.0.0",
44
"license": "SEE LICENSE IN LICENSE",
5-
"repository": "https://github.com/zigurous/css-styles",
5+
"repository": "https://github.com/zigurous/forge-css",
66
"devDependencies": {
77
"husky": "^9.1.6",
88
"lightningcss-cli": "^1.27.0"

0 commit comments

Comments
 (0)