diff --git a/README.md b/README.md index afe82de..82a0c77 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,51 @@ ## :alien: what? `fast vue`'s abbreviation, which is pronounced as `[fiːl]`. Its goal is to make us feel fast when developing :stuck_out_tongue_closed_eyes: + +## usage + +```bash +npm i vuefast -g +# OR +yarn add vuefast -g +``` + +### list + +`fvue list` + +eg: + +```bash +$ fvue list +fvue: A fast vue project cli! + - v3 (v3-tpl) +``` + +- `v3` is the tpl name +- `v3-tpl` is the tpl description + +And now, the tpl list is: + +```json + v3: { + url: "github:Realzzz1874/v3-tpl#fvue-tpl/v3", + desc: "v3-tpl", + repo: "https://github.com/Realzzz1874/v3-tpl/tree/fvue-tpl/v3", + } +``` + +### init + +`fvue init ` + +eg: + +```bash +$ fvue init v3 myVueProject +``` + +- `v3` is the tpl name +- `myVueProject` is the project name + +just like: diff --git a/index.js b/index.js index 5c50076..7f6ef89 100644 --- a/index.js +++ b/index.js @@ -49,17 +49,17 @@ program { type: "input", name: "name", - message: "please input proj name", + message: "please input proj name:", }, { type: "input", name: "description", - message: "please input proj description", + message: "please input proj description:", }, { type: "input", name: "author", - message: "please input proj author", + message: "please input proj author:", }, ]) .then(async (answers) => { @@ -69,7 +69,8 @@ program answers ); fs.writeFileSync(package_path, package_result); - console.log("proj init success"); + const log = chalk.hex("#FFA500"); + console.log(logSymbols.success, log("proj init success.")); }); } } diff --git a/package.json b/package.json index ab883b8..e6b2a13 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "vuefast", - "version": "1.0.0", + "version": "1.0.1", "description": "fast vue cli", "main": "index.js", "scripts": {