-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Rebrand library as part of new Forge design system
- Loading branch information
1 parent
5b7b4ed
commit c93d40f
Showing
3 changed files
with
37 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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"> | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters