Skip to content

Commit 1a15f03

Browse files
author
Attila Max Ruf
committed
feat(readme): add readme, with some documentation
1 parent e1b2b04 commit 1a15f03

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Material Design Icons for Vue.js
2+
3+
4+
This library should grant an easy-to-use interface to icons from MDI.
5+
6+
7+
## Example
8+
9+
```
10+
const Vue = require('vue')
11+
const HumanIcon = require('mdi-vue/HumanIcon')
12+
13+
new Vue({
14+
el: '#some-html-element',
15+
template: '<span><mdi-human-icon /></span>'
16+
})
17+
```
18+
19+
20+
Heavily inspired by [mdi-react](https://github.com/levrik/mdi-react/).

package.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,11 @@
1919
"url": "https://github.com/therufa/mdi-vue/issues"
2020
},
2121
"author": "Attila Max Ruf <attila.ruf@oden.hu>",
22-
"license": "(MIT + OFL-1.1)",
22+
"license": "MIT",
2323
"scripts": {
2424
"clean": "rm -rf build dist",
2525
"prebuild": "git submodule update --init && npm run clean && mkdir build dist",
26-
"postbuild": "echo \"Build is done.\"",
27-
"build": "node build.js && babel build --out-dir dist",
26+
"build": "node build.js && babel build --out-dir dist && cp *LICENSE dist",
2827
"prepublish": "cd .. && npm run build && cd ./dist"
2928
},
3029
"peerDependencies": {

0 commit comments

Comments
 (0)