Skip to content

Commit e84cc42

Browse files
committed
chore(docs): add example usage gif
1 parent 3df647a commit e84cc42

File tree

2 files changed

+25
-16
lines changed

2 files changed

+25
-16
lines changed

README.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
[![NPM][1]][2]
66

7+
![example usage][4]
8+
79

810
## overview
911

@@ -25,23 +27,29 @@ npm i vue-cli-template-dev-server -D
2527

2628
## usage
2729

28-
in your custom vue-cli template project, add these bits:
29-
30-
*package.json*
31-
32-
```json5
33-
{
34-
"scripts": {
35-
"dev": "vue-cli-template-dev-server"
36-
},
37-
}
38-
```
39-
40-
*.gitignore*
30+
- in your custom vue-cli template project, add these bits:
31+
32+
*package.json*
33+
34+
```json5
35+
{
36+
"scripts": {
37+
"dev": "vue-cli-template-dev-server"
38+
},
39+
}
40+
```
41+
42+
*.gitignore*
43+
44+
```gitignore
45+
out/
46+
```
4147

42-
```gitignore
43-
out/
44-
```
48+
- than, run:
49+
50+
```sh
51+
npm run dev
52+
```
4553

4654

4755
## demo
@@ -90,4 +98,5 @@ use the `-h` flag to see the manual.
9098
[1]: https://img.shields.io/npm/v/vue-cli-template-dev-server.svg?style=flat-square
9199
[2]: https://www.npmjs.com/package/vue-cli-template-dev-server
92100
[3]: https://github.com/vuejs/vue-cli/tree/master#custom-templates
101+
[4]: resources/example-usage.gif
93102
[5]: example

resources/example-usage.gif

7.47 MB
Loading

0 commit comments

Comments
 (0)