5 Commits

Author SHA1 Message Date
Konstantin Vulsonov
dbf0994650 readme fix 2018-09-21 01:58:04 +03:00
Konstantin Vulsonov
b9745233ab Update type definition for TS 2018-09-21 01:57:07 +03:00
Konstantin Vulsonov
225e6dea60 add ts typedef 2018-09-21 01:57:02 +03:00
Konstantin Vulsonov
5bc85cfee3 Update README.md 2018-09-20 01:27:07 +03:00
Konstantin Vulsonov
1374a3a65a Update README.md 2018-09-20 01:07:37 +03:00
3 changed files with 9 additions and 4 deletions

View File

@@ -24,7 +24,7 @@ svg-iconset --source=assets/images/icons --result=icons
``` ```
Creates a file `icons-iconset.svg` in same folder Creates a file `icons-iconset.svg` in same folder
### In Project ### In Project
``` ```javascript
const SvgIconset = require('svg-iconset'); const SvgIconset = require('svg-iconset');
const config = { const config = {
@@ -32,9 +32,13 @@ const config = {
result: 'icons', // Required result: 'icons', // Required
// This is optional for optimize files using SVGO plugins // This is optional for optimize files using SVGO plugins
optimize: { optimize: {
removeViewBox: true, // Will remove attribute viewBox (default true) removeViewBox: true, // Will remove attribute viewBox
} }
} }
new SvgIconset(config).createSet(); new SvgIconset(config).createSet();
``` ```
#### Additional
[Default SVGO optimisation config](https://github.com/DariusNorv/svg-iconset/wiki#default-svgo-configuration)

2
package-lock.json generated
View File

@@ -1,6 +1,6 @@
{ {
"name": "@vkl/svg-iconset-builder", "name": "@vkl/svg-iconset-builder",
"version": "1.0.0", "version": "1.0.1",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
"dependencies": { "dependencies": {

View File

@@ -1,8 +1,9 @@
{ {
"name": "@vkl/svg-iconset-builder", "name": "@vkl/svg-iconset-builder",
"version": "1.0.0", "version": "1.0.1",
"description": "create iconset from separated svg icons", "description": "create iconset from separated svg icons",
"main": "./dist/app.js", "main": "./dist/app.js",
"types": "./dist/app.d.ts",
"scripts": { "scripts": {
"build": "tsc", "build": "tsc",
"prepare": "npm run build", "prepare": "npm run build",