Skip to content

Commit

Permalink
docs: update guide
Browse files Browse the repository at this point in the history
  • Loading branch information
felixpy committed Jan 4, 2019
1 parent d5db83d commit 3095d0e
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 5 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

Expand Down Expand Up @@ -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
Expand All @@ -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
```
Expand Down
8 changes: 6 additions & 2 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,希望能够帮到你!

Expand Down Expand Up @@ -32,6 +32,8 @@ yarn global add @vue/cli

### 安装

#### Preset

你可以通过 preset 的方式直接创建你的项目,它已经包含了 ESLint 等插件的配置。

```bash
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit 3095d0e

Please sign in to comment.