Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Allenice committed Sep 15, 2018
1 parent 5405252 commit b35843f
Show file tree
Hide file tree
Showing 14 changed files with 56 additions and 161 deletions.
23 changes: 22 additions & 1 deletion README-CN.md
Expand Up @@ -47,6 +47,21 @@ vsvg -s /path/to/svg/source -t /path/for/generated/components
}
```

#### Use programming api

```js
import build from 'vue-svgicon/dist/lib/build'
build({
sourcePath: '';
targetPath: '';
ext?: 'js';
es6?: false;
tpl?: '';
idSP?: '_';
svgo?: 'Configuration file path' || {/* svgo config object */}
})
```

```bash
# bash
npm run svg
Expand Down Expand Up @@ -82,12 +97,18 @@ icon.register({
vsvg -s /path/to/svg/source -t /path/for/generated/components --ext ts
```

### 支持 ES6 模块
#### 支持 ES6 模块

```bash
vsvg -s /path/to/svg/source -t /path/for/generated/components --ext ts --es6
```

#### 自定义 svgo

```bash
vsvg -s /path/to/svg/source -t /path/for/generated/components --svgo svgo.js
```

### 使用生成的图标

首先,你需要为 `vue-svgicon` 在全局写一些样式代码。推荐的代码如下:
Expand Down
19 changes: 17 additions & 2 deletions README.md
Expand Up @@ -53,6 +53,21 @@ npm run svg

It will generate icons to the specified path.

#### Use programming api

```js
import build from 'vue-svgicon/dist/lib/build'
build({
sourcePath: '';
targetPath: '';
ext?: 'js';
es6?: false;
tpl?: '';
idSP?: '_';
svgo?: 'Configuration file path' || {/* svgo config object */}
})
```

#### Custom icon content format

```bash
Expand Down Expand Up @@ -80,13 +95,13 @@ icon.register({
vsvg -s /path/to/svg/source -t /path/for/generated/components --ext ts
```

### Suport ES6 modules
#### Suport ES6 modules

```bash
vsvg -s /path/to/svg/source -t /path/for/generated/components --ext ts --es6
```

### Custom svgo
#### Custom svgo

```bash
vsvg -s /path/to/svg/source -t /path/for/generated/components --svgo svgo.js
Expand Down
4 changes: 3 additions & 1 deletion babel.config.js
@@ -1,9 +1,11 @@
const appEnv = process.env.APP_ENV

module.exports = {
presets: [
[
'@vue/app',
{
useBuiltIns: false
useBuiltIns: appEnv === 'lib' ? false : 'usage'
}
]
]
Expand Down
2 changes: 1 addition & 1 deletion demo/index.html
@@ -1 +1 @@
<!DOCTYPE html><html><head><meta charset=utf-8><meta http-equiv=X-UA-Compatible content="IE=edge"><meta name=viewport content="width=device-width,initial-scale=1"><link rel=icon href=/vue-svgicon/favicon.ico><title>vue-svgicon</title><link href=/vue-svgicon/js/50d1.6b40a290.js rel=prefetch><link href=/vue-svgicon/css/chunk-vendors.8de836b6.css rel=preload as=style><link href=/vue-svgicon/css/style.5229cc21.css rel=preload as=style><link href=/vue-svgicon/js/app.0e520ceb.js rel=preload as=script><link href=/vue-svgicon/js/chunk-vendors.2d7fcd0c.js rel=preload as=script><link href=/vue-svgicon/js/style.d457e470.js rel=preload as=script><link href=/vue-svgicon/css/chunk-vendors.8de836b6.css rel=stylesheet><link href=/vue-svgicon/css/style.5229cc21.css rel=stylesheet></head><body><noscript><strong>We're sorry but vue-svgicon doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id=app></div><script src=/vue-svgicon/js/chunk-vendors.2d7fcd0c.js></script><script src=/vue-svgicon/js/app.0e520ceb.js></script><script src=/vue-svgicon/js/style.d457e470.js></script></body></html>
<!DOCTYPE html><html><head><meta charset=utf-8><meta http-equiv=X-UA-Compatible content="IE=edge"><meta name=viewport content="width=device-width,initial-scale=1"><link rel=icon href=/vue-svgicon/favicon.ico><title>vue-svgicon</title><link href=/vue-svgicon/js/50d1.6b40a290.js rel=prefetch><link href=/vue-svgicon/css/chunk-vendors.8de836b6.css rel=preload as=style><link href=/vue-svgicon/css/style.5229cc21.css rel=preload as=style><link href=/vue-svgicon/js/app.af160ae4.js rel=preload as=script><link href=/vue-svgicon/js/chunk-vendors.e645f460.js rel=preload as=script><link href=/vue-svgicon/js/style.d457e470.js rel=preload as=script><link href=/vue-svgicon/css/chunk-vendors.8de836b6.css rel=stylesheet><link href=/vue-svgicon/css/style.5229cc21.css rel=stylesheet></head><body><noscript><strong>We're sorry but vue-svgicon doesn't work properly without JavaScript enabled. Please enable it to continue.</strong></noscript><div id=app></div><script src=/vue-svgicon/js/chunk-vendors.e645f460.js></script><script src=/vue-svgicon/js/app.af160ae4.js></script><script src=/vue-svgicon/js/style.d457e470.js></script></body></html>
12 changes: 0 additions & 12 deletions demo/js/app.0e520ceb.js

This file was deleted.

1 change: 0 additions & 1 deletion demo/js/app.0e520ceb.js.map

This file was deleted.

2 changes: 2 additions & 0 deletions demo/js/app.af160ae4.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions demo/js/app.af160ae4.js.map

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion demo/js/chunk-vendors.2d7fcd0c.js.map

This file was deleted.

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions demo/js/chunk-vendors.e645f460.js.map

Large diffs are not rendered by default.

125 changes: 1 addition & 124 deletions dist/polyfill.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -12,7 +12,7 @@
"serve:lib": "tsc -w -p ./lib/tsconfig.json",
"build": "APP_ENV=lib vue-cli-service build --target lib --name svgicon ./src/components/SvgIcon.vue",
"build:lib": "rm -rf dist/lib && tsc -p ./lib/tsconfig.json",
"build:polyfill": "webpack -w",
"build:polyfill": "APP_ENV=lib webpack",
"build:demo": "vue-cli-service build",
"deploy:demo": "yarn build:demo && ./scripts/deploy.sh",
"test": "vue-cli-service test:unit",
Expand Down
14 changes: 2 additions & 12 deletions webpack.config.js
Expand Up @@ -5,7 +5,7 @@ const BundleAnalyzerPlugin = require('webpack-bundle-analyzer')
const REPORT = process.env.REPORT

let config = {
mode: 'development',
mode: 'production',
entry: {
polyfill: './polyfill/index.js'
},
Expand All @@ -20,17 +20,7 @@ let config = {
{
test: /\.js$/,
loader: 'babel-loader',
exclude: /node_modules/,
options: {
presets: [
[
'@babel/preset-env',
{
useBuiltIns: false
}
]
]
}
exclude: /node_modules/
}
]
},
Expand Down

0 comments on commit b35843f

Please sign in to comment.