From 3095d0ec0ad1b49204d3730ef9e8ef35841fa31a Mon Sep 17 00:00:00 2001 From: felixpy Date: Fri, 4 Jan 2019 22:36:01 +0800 Subject: [PATCH] docs: update guide --- README.md | 8 ++++++-- README.zh-CN.md | 8 ++++++-- package.json | 2 +- 3 files changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5953040..cafd7fb 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![License](https://img.shields.io/npm/l/@codetrial/vue-cli-plugin-element.svg)](https://www.npmjs.com/package/@codetrial/vue-cli-plugin-element) [![Dependencies](https://img.shields.io/david/codetrial/vue-cli-plugin-element.svg)](https://www.npmjs.com/package/@codetrial/vue-cli-plugin-element) -Quickly build a backend system with vue-cli and element-ui in seconds. +Quickly build an enterprise application with vue-cli and element-ui in seconds. This project is not only a vue-cli plugin but also a vue-cli preset. Have fun! @@ -32,12 +32,16 @@ yarn global add @vue/cli ### Install +#### Preset + You can create your project directly via preset, which already includes configurations such as ESLint and other plugins. ```bash vue create --preset codetrial/vue-cli-plugin-element your-awesome-project ``` +#### Plugin + If you don't want to use the preset , you can manually create an empty project via vue-cli. ```bash @@ -46,7 +50,7 @@ If you don't want to use the preset , you can manually create an empty project v # - PWA # - Router # - Vuex -# - CSS Pre-processors +# - CSS Pre-processors + Sass # - Linter - Formatter vue create your-awesome-project ``` diff --git a/README.zh-CN.md b/README.zh-CN.md index 3762eb5..89e18c3 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -4,7 +4,7 @@ [![License](https://img.shields.io/npm/l/@codetrial/vue-cli-plugin-element.svg)](https://www.npmjs.com/package/@codetrial/vue-cli-plugin-element) [![Dependencies](https://img.shields.io/david/codetrial/vue-cli-plugin-element.svg)](https://www.npmjs.com/package/@codetrial/vue-cli-plugin-element) -使用 vue-cli 及 element-ui 闪电般构建一个后台管理系统。 +使用 vue-cli 及 element-ui 闪电般构建一个企业级后台管理系统。 这个项目不仅仅是一个 vue-cli 插件,也是一个 vue-cli preset,希望能够帮到你! @@ -32,6 +32,8 @@ yarn global add @vue/cli ### 安装 +#### Preset + 你可以通过 preset 的方式直接创建你的项目,它已经包含了 ESLint 等插件的配置。 ```bash @@ -46,11 +48,13 @@ vue create --preset codetrial/vue-cli-plugin-element your-awesome-project # - PWA # - Router # - Vuex -# - CSS Pre-processors +# - CSS Pre-processors + Sass # - Linter - Formatter vue create your-awesome-project ``` +#### Plugin + 然后通过 vue 将插件添加到你的项目中。 ```bash diff --git a/package.json b/package.json index 7a83eec..21e905b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@codetrial/vue-cli-plugin-element", - "version": "1.0.2", + "version": "1.0.3", "description": "Quickly build a backend system with vue-cli and element-ui in seconds.", "main": "index.js", "scripts": {