Skip to content

Commit

Permalink
chore(README)
Browse files Browse the repository at this point in the history
  • Loading branch information
phucbm committed May 31, 2023
1 parent 6fb4a75 commit 37d5bdc
Showing 1 changed file with 6 additions and 23 deletions.
29 changes: 6 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Atomic CSS

[![npm](https://badgen.net/npm/v/@viivue/atomic-css)](https://www.npmjs.com/package/@viivue/atomic-css)
[![minified](https://badgen.net/badge/minified/~11KB/cyan)](https://www.jsdelivr.com/package/gh/viivue/atomic-css)
[![minified](https://badgen.net/badge/minified/~8KB/cyan)](https://www.jsdelivr.com/package/gh/viivue/atomic-css)
[![jsdelivr](https://data.jsdelivr.com/v1/package/gh/viivue/atomic-css/badge?style=rounded)](https://www.jsdelivr.com/package/gh/viivue/atomic-css)
[![license](https://badgen.net/github/license/viivue/atomic-css/)](https://github.com/viivue/atomic-css/blob/main/LICENSE)

Expand Down Expand Up @@ -42,34 +42,17 @@ To add custom classes for a specific project, you will have to:

## Deployment

Install `npm`

```shell
npm install
```

### Dev

Watch SCSS files, then compile to previewed CSS

```shell
# Watch SCSS files, then compile to previewed CSS
npm run dev
```

### Prod

Compile compressed CSS for distribution.

> Check version at `_defs.scss` and `package.json`
```shell
# Compile compressed CSS for distribution.
# Check version at `_defs.scss` and `package.json`
npm run prod
```

### Publish NPM package

Increase version in `package.json` and `scss/_def.scss`

```shell
# Publish NPM package
# Auto-publish package on release using GitHub workflow
npm publish
```

0 comments on commit 37d5bdc

Please sign in to comment.