Skip to content

Commit

Permalink
feat(readme): add readme, with some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Attila Max Ruf committed May 19, 2017
1 parent e1b2b04 commit 1a15f03
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Material Design Icons for Vue.js


This library should grant an easy-to-use interface to icons from MDI.


## Example

```
const Vue = require('vue')
const HumanIcon = require('mdi-vue/HumanIcon')
new Vue({
el: '#some-html-element',
template: '<span><mdi-human-icon /></span>'
})
```


Heavily inspired by [mdi-react](https://github.com/levrik/mdi-react/).
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,11 @@
"url": "https://github.com/therufa/mdi-vue/issues"
},
"author": "Attila Max Ruf <attila.ruf@oden.hu>",
"license": "(MIT + OFL-1.1)",
"license": "MIT",
"scripts": {
"clean": "rm -rf build dist",
"prebuild": "git submodule update --init && npm run clean && mkdir build dist",
"postbuild": "echo \"Build is done.\"",
"build": "node build.js && babel build --out-dir dist",
"build": "node build.js && babel build --out-dir dist && cp *LICENSE dist",
"prepublish": "cd .. && npm run build && cd ./dist"
},
"peerDependencies": {
Expand Down

0 comments on commit 1a15f03

Please sign in to comment.