Skip to content

Commit

Permalink
Rebrand library as part of new Forge design system
Browse files Browse the repository at this point in the history
  • Loading branch information
adamgraham committed Nov 19, 2024
1 parent 5b7b4ed commit c93d40f
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cdn-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@ jobs:
- name: Sync files to S3 bucket
run: |
PACKAGE_VERSION=$(npm pkg get version --workspaces=false | tr -d \")
aws s3 sync dist s3://cdn.zigurous.com/css-styles@$PACKAGE_VERSION/dist --delete
aws s3 sync dist s3://cdn.zigurous.com/forge-css@$PACKAGE_VERSION/dist --delete
45 changes: 33 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,45 @@
# @zigurous/css-styles
# Forge CSS

The official CSS implementation of the Forge design system created by [@zigurous](https://github.com/zigurous).

## Installation

Add scoped package registry to `.npmrc` file
### NPM

Set the scoped package registry in your `.npmrc` file:
```bash
registry=https://registry.npmjs.org/
@zigurous:registry=https://npm.pkg.github.com
```

Run one of the following commands in a terminal
```bash
npm install @zigurous/css-styles
# or
yarn add @zigurous/css-styles
# or
pnpm add @zigurous/css-styles
Run one of the following commands in a terminal:
- Install with npm `npm install @zigurous/forge-css`
- Install with yarn `yarn add @zigurous/forge-css`
- Install with pnpm `pnpm add @zigurous/forge-css`

Import the css file in your code:
```js
import '@zigurous/forge-css/dist/index.min.css'
```

### CDN

Add one of the following links to your HTML:

#### Cloudfront

```html
<link href="https://cdn.zigurous.com/[email protected]/dist/index.min.css" rel="stylesheet">
```

#### jsDelivr

```html
<link href="https://cdn.jsdelivr.net/gh/zigurous/[email protected]/dist/index.min.css" rel="stylesheet">
```

## Usage
#### statically

```jsx
import '@zigurous/css-styles/dist/index.min.css'
```html
<link href="https://cdn.statically.io/gh/zigurous/forge-css/1.0.0/dist/index.min.css" rel="stylesheet">
```
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "@zigurous/css-styles",
"version": "3.0.0",
"name": "@zigurous/forge-css",
"version": "1.0.0",
"license": "SEE LICENSE IN LICENSE",
"repository": "https://github.com/zigurous/css-styles",
"repository": "https://github.com/zigurous/forge-css",
"devDependencies": {
"husky": "^9.1.6",
"lightningcss-cli": "^1.27.0"
Expand Down

0 comments on commit c93d40f

Please sign in to comment.