docs: move cli into dedicated file

carlosrojaso · Feb 8, 2018 · 2756cdd · 2756cdd
1 parent 55cb4c0
commit 2756cdd
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 84 deletions.
diff --git a/README.md b/README.md
@@ -6,98 +6,16 @@
 
 Certain combinations of plugins may not work properly, and things may break until we reach beta phase. Do not use in production yet unless you are adventurous.
 
-## Install
+## Quickstart
 
 ``` sh
 npm install -g @vue/cli
 # or
 yarn global add @vue/cli
-```
-
-## Usage
-
-### Creating a New Project
 
-``` sh
 vue create my-project
 ```
 
-<p align="center">
-  <img width="682px" src="https://raw.githubusercontent.com/vuejs/vue-cli/dev/docs/screenshot.png">
-</p>
-
-### Zero-config Prototyping
-
-You can rapidly prototype with just a single `*.vue` file with the `vue serve` and `vue build` commands, but they require an additional global addon to be installed:
-
-``` sh
-yarn global add @vue/cli-service-global
-echo '<template><h1>Hello!</h1></template>' > App.vue
-vue serve
-```
-
-`vue serve` uses the same default setup (webpack, babel, postcss & eslint) as projects created by `vue create`. It automatically infers the entry file in the current directory - the entry can be one of `main.js`, `index.js`, `App.vue` or `app.vue`. If needed, you can also provide an `index.html`, install and use local dependencies, or even configure babel, postcss & eslint with corresponding config files.
-
-The drawback of `vue serve` is that it relies on globally installed dependencies which may be inconsistent on different machines. Therefore this is only recommended for rapid prototyping.
-
-### Installing Plugins in an Existing Project
-
-Each CLI plugin ships with a generator (which creates files) and a runtime plugin (which tweaks the core webpack config and injects commands). When you use `vue create` to create a new project, some plugins will be pre-installed for you based on your feature selection. In case you want to install a plugin into an already created project, simply install it first:
-
-``` sh
-yarn add @vue/cli-plugin-eslint
-```
-
-Then you can invoke the plugin's generator so it generates files into your project:
-
-``` sh
-# the @vue/cli-plugin- prefix can be omitted
-vue invoke eslint
-```
-
-In addition, you can pass options to the plugin:
-
-``` sh
-vue invoke eslint --config airbnb --lintOn save
-```
-
-It is recommended to commit your project's current state before running `vue invoke`, so that after file generation you can review the changes and revert if needed.
-
-### Pulling `vue-cli@2.x` Templates (Legacy)
-
-`@vue/cli` uses the same `vue` binary, so it overwrites `vue-cli@2.x`. If you still need the legacy `vue init` functionality, you can install a global bridge:
-
-``` sh
-yarn global add @vue/cli-init
-# vue init now works exactly the same as vue-cli@2.x
-vue init webpack my-project
-```
-
-### Customizing Webpack Config
-
-Create a `vue.config.js` in project root: (**Note:** if you have a `vue` field in your `package.json`, you need to move that here as well)
-
-``` js
-// vue.config.js
-module.exports = {
-  chainWebpack: chainableConfig => {
-     // modify config with webpack-chain
-     // https://github.com/mozilla-neutrino/webpack-chain
-  },
-
-  configureWebpack: config => {
-    // mutate config directly, or return new config
-  },
-
-  // object literal will be merged into base config using webpack-merge
-  configureWebpack: {
-    // ...
-  }
-}
-```
-
-### Recipes and Plugin Usage
-
 For a detailed guide with recipes for common tasks, detailed usage for each plugin, please see the [full documentation](https://github.com/vuejs/vue-cli/blob/dev/docs/README.md).
 
 ## Contributing

diff --git a/docs/README.md b/docs/README.md
@@ -39,7 +39,7 @@ npm install -g @vue/cli
 vue create my-project
 ```
 
-For full details on what the `vue` command can do, see the [full CLI docs](https://github.com/vuejs/vue-cli/blob/dev/packages/%40vue/cli/README.md).
+For full details on what the `vue` command can do, see the [full CLI docs](./cli.md).
 
 ## CLI Service
 

diff --git a/docs/cli.md b/docs/cli.md
@@ -0,0 +1,58 @@
+## CLI Usage
+
+### Creating a New Project
+
+``` sh
+vue create my-project
+```
+
+<p align="center">
+  <img width="682px" src="https://raw.githubusercontent.com/vuejs/vue-cli/dev/docs/screenshot.png">
+</p>
+
+### Zero-config Prototyping
+
+You can rapidly prototype with just a single `*.vue` file with the `vue serve` and `vue build` commands, but they require an additional global addon to be installed:
+
+``` sh
+yarn global add @vue/cli-service-global
+echo '<template><h1>Hello!</h1></template>' > App.vue
+vue serve
+```
+
+`vue serve` uses the same default setup (webpack, babel, postcss & eslint) as projects created by `vue create`. It automatically infers the entry file in the current directory - the entry can be one of `main.js`, `index.js`, `App.vue` or `app.vue`. If needed, you can also provide an `index.html`, install and use local dependencies, or even configure babel, postcss & eslint with corresponding config files.
+
+The drawback of `vue serve` is that it relies on globally installed dependencies which may be inconsistent on different machines. Therefore this is only recommended for rapid prototyping.
+
+### Installing Plugins in an Existing Project
+
+Each CLI plugin ships with a generator (which creates files) and a runtime plugin (which tweaks the core webpack config and injects commands). When you use `vue create` to create a new project, some plugins will be pre-installed for you based on your feature selection. In case you want to install a plugin into an already created project, simply install it first:
+
+``` sh
+yarn add @vue/cli-plugin-eslint
+```
+
+Then you can invoke the plugin's generator so it generates files into your project:
+
+``` sh
+# the @vue/cli-plugin- prefix can be omitted
+vue invoke eslint
+```
+
+In addition, you can pass options to the plugin:
+
+``` sh
+vue invoke eslint --config airbnb --lintOn save
+```
+
+It is recommended to commit your project's current state before running `vue invoke`, so that after file generation you can review the changes and revert if needed.
+
+### Pulling `vue-cli@2.x` Templates (Legacy)
+
+`@vue/cli` uses the same `vue` binary, so it overwrites `vue-cli@2.x`. If you still need the legacy `vue init` functionality, you can install a global bridge:
+
+``` sh
+yarn global add @vue/cli-init
+# vue init now works exactly the same as vue-cli@2.x
+vue init webpack my-project
+```