Skip to content

Commit bd844d5

Browse files
committed
Update documentation
1 parent fa202ca commit bd844d5

File tree

4 files changed

+34
-326
lines changed

4 files changed

+34
-326
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,18 +46,18 @@ yarn global add svg-symbol-sprite
4646
| `-i`, `--input` | Specifies input dir (current dir by default) |
4747
| `-o`, `--output` | Specifies output file ("./sprite.svg" by default) |
4848
| `-v`, `--viewbox` | Specifies viewBox attribute (parsed by default) |
49-
| `-p`, `--prefix` | Specifies prefix for id attribute ('icon-' by default) |
50-
| `-c`, `--config` | Absolute path to the config file for SVGO-ViewBox. |
49+
| `-p`, `--prefix` | Specifies prefix for id attribute ("icon-" by default) |
50+
| `-c`, `--config` | Absolute path to the SVGO config file |
5151

5252
```sh
5353
Usage: svg-symbol-sprite [options]
5454

5555
Options:
5656
-i, --input Specifies input dir (current dir by default)
57-
-o, --output Specifies output file (./sprite.svg by default)
57+
-o, --output Specifies output file ("./sprite.svg" by default)
5858
-v, --viewbox Specifies viewBox attribute (parsed by default)
59-
-p, --prefix Specifies prefix for id attribute (icon- by default)
60-
-c, --config Absolute path to the config file for SVGO-ViewBox.
59+
-p, --prefix Specifies prefix for id attribute ("icon-" by default)
60+
-c, --config Absolute path to the SVGO config file
6161
```
6262

6363
## Usage as a package.json script

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "svg-symbol-sprite",
3-
"version": "1.0.2",
3+
"version": "1.0.3",
44
"description": "A script to generate a symbol sprite from SVG files",
55
"keywords": [
66
"SVG",
@@ -52,13 +52,13 @@
5252
"dependencies": {
5353
"cheerio": "1.0.0-rc.10",
5454
"commander": "8.3.0",
55-
"release-it": "14.11.8",
56-
"svgo-viewbox": "2.0.4"
55+
"svgo": "2.8.0"
5756
},
5857
"devDependencies": {
5958
"@types/cheerio": "0.22.30",
6059
"@types/node": "17.0.7",
6160
"@types/svgo": "2.6.0",
61+
"release-it": "14.11.8",
6262
"tslib": "2.3.1",
6363
"typescript": "4.5.4"
6464
},

src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ cli.option('-i, --input [input]', 'Specifies input dir (current dir by default)'
2525
.option('-o, --output [output]', 'Specifies output file ("./sprite.svg" by default)', 'sprite.svg')
2626
.option('-v, --viewbox [viewbox]', 'Specifies viewBox attribute (parsed by default)', '')
2727
.option('-p, --prefix [prefix]', 'Specifies prefix for id attribute ("icon-" by default)', 'icon-')
28-
.option('-c, --config [config]', 'Absolute path to the config file for SVGO-ViewBox.', './config/svgo.config.js')
28+
.option('-c, --config [config]', 'Absolute path to the SVGO config file', './config/svgo.config.js')
2929
.parse(process.argv);
3030

3131
const { input: INPUT, output: OUTPUT, viewbox: VIEWBOX, prefix: PREFIX, quiet: QUIET, config: CONFIG } = cli.opts();

0 commit comments

Comments
 (0)