docs: add README-en.md

README-en.md

@@ -0,0 +1,44 @@
+# YKit [![CircleCI](https://circleci.com/gh/YMFE/ykit.svg?style=shield)](https://circleci.com/gh/YMFE/ykit)
+
+YKit is a toolkit encapsulates and manages Webpack configuration for various types of web apps. It provides best practice through plugins and helps you create and customize apps through flexible config options.
+
+## Features
+
+- create project in one command
+- support react/vue/ant-design/ts/... config plugins
+- hot reloading dev server
+
+## Install
+
+- Latest version: `[sudo] npm install ykit -g`
+- Or you can choose the newest version：`[sudo] npm install ykit@next -g`
+
+## Quick Start
+
+1. `mkdir ykit-app && cd ykit-app`
+2. `ykit init`
+3. `ykit s -p 3000`
+4. Check out `http://127.0.0.1:3000/index.html`
+
+After setting up your project, there will be the config file called `ykit.js` in your project root directory：
+
+```javascript
+module.exports = {
+    plugins: [],
+    config: {
+        export: ['./scripts/index.js', './styles/index.css'],
+        modifyWebpackConfig: function (baseConfig) {
+            // edit webpack configs
+            return baseConfig;
+        }
+    },
+    hooks: {},
+    commands: []
+};
+```
+
+## Document
+
+Visit [https://ykit.ymfe.org/][1] for more doc.
+
+[1]: https://ykit.ymfe.org/

README.md

@@ -1,5 +1,7 @@
 # YKit [![CircleCI](https://circleci.com/gh/YMFE/ykit.svg?style=shield)](https://circleci.com/gh/YMFE/ykit)
 
+[ENGLISH](./README-en.md)
+
 YKit 是一个基于 Webpack 的打包工具，它利用插件机制封装了各种 JavaScript 应用的配置，选择和安装合适的插件即可开始构建你的应用。
 
 ## 特性
@@ -11,10 +13,11 @@ YKit 是一个基于 Webpack 的打包工具，它利用插件机制封装了各
 ## 安装
 
 - latest 稳定版: `[sudo] npm install ykit -g`
-- 基于 Webpack@3.8.1 的最新版本：`[sudo] npm install ykit@next -g`
+- 或者选择基于 Webpack@3.8.1 的最新版本：`[sudo] npm install ykit@next -g`
 
 ## 快速开始
 
+
 1. 创建目录 `mkdir ykit-app && cd ykit-app`
 2. 初始化工程 `ykit init`
 3. 启动服务 `ykit s -p 3000`
@@ -27,7 +30,7 @@ module.exports = {
     plugins: [],
     config: {
         export: ['./scripts/index.js', './styles/index.css'],
-        modifyWebpackConfig: function modifyWebpackConfig(baseConfig) {
+        modifyWebpackConfig: function (baseConfig) {
             // 更改 Webpack 配置
             return baseConfig;
         }