Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
blasdfaa committed Jul 13, 2024
1 parent 5b87207 commit bb9fd6c
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,24 @@

SVG library Generator - This is a simple and convenient cli app for creating SVG icon libraries. With it, you can easily combine a set of SVG files into a single library ready for publication in npm.

## New Project

```bash
npx svglb@latest init <project-name>
```

Change directory into your new project from your terminal:

```bash
cd <project-name>
```

Build icons libary:

```bash
npm run build
```

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/svglb?style=flat&colorA=080f12&colorB=1fa669
Expand Down

0 comments on commit bb9fd6c

Please sign in to comment.