Skip to content

Commit 629409b

Browse files
Readme update
1 parent 63b29b5 commit 629409b

File tree

1 file changed

+31
-6
lines changed

1 file changed

+31
-6
lines changed

README.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,39 @@
1+
# vue-svg-loader
2+
A webpack loader that allows to use SVG files as Vue Components.
3+
4+
## Installation
5+
`npm install --save-dev vue-svg-loader`
6+
7+
## Configuration
18
```js
29
{
310
test: /\.svg$/,
4-
loader: 'vue-svg-loader',
11+
loader: 'vue-svg-loader', // `vue-svg` for webpack 1.x
512
}
613
```
714

8-
```js
9-
import SomeIcon from './assets/svg/some-icon.svg';
10-
```
15+
## Example code
16+
17+
```html
18+
<template>
19+
<nav id="menu">
20+
<a href="...">
21+
<SomeIcon class="icon" />
22+
Some page
23+
</a>
24+
</nav>
25+
</template>
26+
27+
<script>
28+
import SomeIcon from './assets/some-icon.svg';
1129
12-
```vue
13-
<SomeIcon />
30+
export default {
31+
name: 'menu',
32+
components: {
33+
SomeIcon,
34+
},
35+
};
36+
</script>
1437
```
38+
---
39+
*The idea behind this was inspired by [react-svg-loader](https://github.com/boopathi/react-svg-loader)*.

0 commit comments

Comments
 (0)