Skip to content

Commit 3ae6772

Browse files
committed
📔 Adding documentation
1 parent d76bba1 commit 3ae6772

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# vue-component
2+
3+
> A vue-cli who create a default external Vue.js component template
4+
5+
[![version](https://img.shields.io/badge/version-1.0.0-green.svg?style=flat-square)](https://github.com/pierrechls/seed) [![js-standard-style](https://img.shields.io/badge/code_style-standard-lightgrey.svg?style=flat-square)](http://standardjs.com/) [![sass-stylesheets](https://img.shields.io/badge/stylesheets-sass-lightgrey.svg?style=flat-square)](http://sass-lang.com/)
6+
7+
## How to use it
8+
9+
#### Install vue-cli as global
10+
11+
``` bash
12+
$ npm install -g vue-cli
13+
```
14+
15+
#### Init your project
16+
17+
``` bash
18+
$ vue init pierrechls/vue-component my-vue-component # init template
19+
$ cd my-vue-component # go to your project folder
20+
$ npm install # install dependencies (or `yarn`)
21+
$ npm run dev # serve with hot reload
22+
$ npm run build # build for production
23+
```
24+
25+
For detailed explanation on how things work, checkout the [guide](https://github.com/pierrechls/vue-component)  📚 .

0 commit comments

Comments
 (0)