Skip to content

Commit 8aa4e6d

Browse files
committed
Add usage and update description
1 parent b56c384 commit 8aa4e6d

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
# Generator-abstack-vuejs
2-
A yeoman generator for Vue.js
2+
A yeoman generator for Vue.js.
3+
4+
## Usage
5+
You must install the [yeoman](https://github.com/yeoman/yeoman) first:
6+
7+
```bash
8+
npm install -g yo
9+
```
10+
11+
Then:
12+
13+
```bash
14+
# install
15+
npm install -g generator-abstack-vuejs
16+
17+
# generate project
18+
yo abstack-vuejs
19+
```
320

421
## Changelog
522
Visit [release notes](https://github.com/PeachScript/generator-abstack-vuejs/releases)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "generator-abstack-vuejs",
33
"version": "0.2.1",
4-
"description": "A yeoman generate with Vue.js",
4+
"description": "A yeoman generator for Vue.js",
55
"main": "index.js",
66
"scripts": {
77
"test": "echo \"Error: no test specified\" && exit 1"

0 commit comments

Comments
 (0)