[feature] 优化传参，增加readme

Author: 张柯雨

.editorconfig

@@ -2,6 +2,107 @@
 
 > Automatically generate routes and menu by given privilege
 
+## Usage
+
+#### PrivilegeMenu Attribute
+
+参数 | 说明 | 类型 | 可选值 | 默认值
+-----|-----|-----|------|------
+routerMap|必传,根据此参数生成router,详细使用见下方示例|array|-|-
+role|当前用户角色,配合routerMap使用|string|-|-
+mode|模式|string|horizontal / vertical|vertical
+collapse|是否水平折叠收起菜单（仅在 mode 为 vertical 时可用）|boolean|-|false
+background-color|菜单的背景色（仅支持 hex 格式）|string|—|#ffffff
+text-color|菜单的文字颜色（仅支持 hex 格式）|string|—|#303133
+active-text-color|当前激活菜单的文字颜色（仅支持 hex 格式）|string|—|#409EFF
+default-active|当前激活菜单的|index|string|—|—
+default-openeds|当前打开的 sub-menu 的 index 的数组|Array|—|—
+unique-opened|是否只保持一个子菜单的展开|boolean|—|false
+menu-trigger|子菜单打开的触发方式(只在 mode 为 horizontal 时有效)|string|hover / click|hover
+router|是否使用 vue-router 的模式，启用该模式会在激活导航时以 index 作为 path 进行路由跳转|boolean|—|false
+collapse-transition|是否开启折叠动画|boolean|—|true
+
+
+#### PrivilegeMenu Events
+
+事件名称|说明|回调参数
+-----|-----|------
+select|菜单激活回调|index: 选中菜单项的 index, indexPath: 选中菜单项的 index path
+open|sub-menu 展开的回调|index: 打开的 sub-menu 的 index， indexPath: 打开的 sub-menu 的 index path
+close|sub-menu 收起的回调|index: 收起的 sub-menu 的 index， indexPath: 收起的 sub-menu 的 index path
+
+#### RouterMap Example
+
+``` js
+[
+    {
+        path: '/requestquery',                          //第一层级路径
+        display: '请求查询',                             //名称
+        icon: 'el-icon-s-management',                   //图标（当前节点为最外层menu时渲染）
+        children: [
+            {
+                path: '/logidsearch',                   //第二层级路径，此页面路径为/requestquery/logidsearch
+                display: 'Logid查询',
+                component: a,                           //页面组件
+            },
+            {
+                path: '/conditionsearch',
+                display: '条件查询',
+                component: b,
+                privilege: ['user_admin', 'user_re'],   //拥有查看该页面权限的角色，由role参数传入，有权限的角色可看到并访问此menu项（只在叶节点起作用）
+            },
+            {
+                path: '/c',
+                display: 'c',
+                component: c,
+                notShow: true,                          //有权限角色可以访问该页面，但menu中不展示
+                privilege: ['user_admin', 'user_re'],
+            }
+        ],
+    },
+    {
+        path: '/dataSearch',
+        display: '数据查询',
+        icon: 'el-icon-document',
+        children: [
+            {
+                path: '/narwalSearch',
+                display: 'Narwal查询',
+                component: c,
+                icon: 'el-icon-document',
+                privilege: ['user_admin', 'user_re'],
+            },
+        ],
+    },
+    {
+        path: '/utils',
+        display: '通用工具',
+        icon: 'el-icon-s-tools',
+        children: [
+            {
+                path: '/jsonformatter',
+                display: 'JSON格式化',
+                component: a,
+                privilege: ['user_admin', 'user_re'],
+            },
+            {
+                path: '/transform',
+                display: 'Pin/PinId查询',
+                component: b,
+                privilege: ['user_admin', 'user_re'],
+            },
+            {
+                path: '/jsonquery',
+                display: '数据请求',
+                component: c,
+                icon: 'el-icon-s-tools',
+                privilege: ['user_admin', 'user_re', 'user_pm'],
+            },
+        ],
+    }
+]
+```
+
 ## Build Setup
 
 ``` bash
@@ -13,6 +114,4 @@ npm run dev
 
 # build for production with minification
 npm run build
-```
-
-For detailed explanation on how things work, consult the [docs for vue-loader](http://vuejs.github.io/vue-loader).
+```

README.md

@@ -0,0 +1,77 @@
+module.exports = function(env, argv){
+//   entry: './lib/index.js',
+    return {
+        // entry: './example/main.js',
+        // output: {
+        //     path: path.resolve(__dirname, './dist'),
+        //     publicPath: './dist/',
+        //     filename: 'vue-privilege-menu.js',
+        //     library: 'vuePrivilegeMenu',
+        //     libraryTarget: 'umd',
+        //     umdNamedDefine: true,
+        // },
+        module: {
+            rules: [
+            {
+                test: /\.css$/,
+                use: [
+                'vue-style-loader',
+                'css-loader'
+                ],
+            }, 
+            {
+                test: /\.vue$/,
+                loader: 'vue-loader',
+            },
+            {
+                test: /\.js$/,
+                loader: 'babel-loader',
+                exclude: /node_modules/
+            },
+            {
+                test: /\.(woff|woff2|ttf|eot|png|jpg|gif|svg)$/,
+                loader: 'url-loader',
+                options: {
+                    name: "[name]-[hash:5].[ext]",
+                }
+            }
+            ]
+        },
+        resolve: {
+            alias: {
+                'vue$': 'vue/dist/vue.esm.js'
+            },
+            extensions: ['*', '.js', '.vue', '.json']
+        },
+        // devServer: {
+        //     openPage: './example/index.html',
+        //     historyApiFallback: true,
+        //     noInfo: true,
+        //     overlay: true
+        // },
+            performance: {
+                hints: false
+            },
+            // devtool: '#source-map',
+        }
+
+        // if (process.env.NODE_ENV === 'production') {
+        // module.exports.devtool = '#source-map'
+        // // http://vue-loader.vuejs.org/en/workflow/production.html
+        // module.exports.plugins = (module.exports.plugins || []).concat([
+        //     new webpack.DefinePlugin({
+        //         'process.env': {
+        //             NODE_ENV: '"production"'
+        //         }
+        //     }),
+        //     new webpack.optimize.UglifyJsPlugin({
+        //         sourceMap: true,
+        //         compress: {
+        //             warnings: false
+        //         }
+        //     }),
+        //     new webpack.LoaderOptionsPlugin({
+        //         minimize: true
+        //     })
+        // ])
+}

build/webpack.config.js

@@ -0,0 +1,27 @@
+const baseConfig = require('./webpack.config.js')
+const htmlWebpackPlugin = require('html-webpack-plugin')
+const merge = require('webpack-merge')
+const path = require('path')
+
+module.exports = function(env, argv) {
+    const base = baseConfig(env, argv)
+    return merge(base, {
+        entry: './example/main.js',
+        devServer: {
+            openPage: 'index.html',
+            historyApiFallback: true,
+            noInfo: true,
+            overlay: true
+        },
+        plugins:[
+            new htmlWebpackPlugin({
+                template: './example/index.html',
+                filename: 'index.html',
+                title: 'vue-privilege-menu',
+                inject: true,
+                cache: true,
+            })
+        ],
+        devtool: '#source-map',
+    })
+}

build/webpack.dev.js

@@ -0,0 +1,35 @@
+const baseConfig = require('./webpack.config.js')
+const webpack = require('webpack')
+const path = require('path')
+const merge = require('webpack-merge')
+
+module.exports = function(env, argv) {
+    const base = baseConfig(env, argv)
+    return merge(base, {
+        entry: './lib/index.js',
+        output: {
+            path: path.resolve(__dirname, '../dist'),
+            publicPath: '../dist/',
+            filename: 'vue-privilege-menu.js',
+            library: 'vuePrivilegeMenu',
+            libraryTarget: 'umd',
+            umdNamedDefine: true,
+        },
+        plugins: [
+            new webpack.DefinePlugin({
+                'process.env': {
+                    NODE_ENV: '"production"'
+                }
+            }),
+            new webpack.optimize.UglifyJsPlugin({
+                sourceMap: true,
+                compress: {
+                    warnings: false
+                }
+            }),
+            new webpack.LoaderOptionsPlugin({
+                minimize: true
+            })
+        ]
+    })
+}

build/webpack.prod.js

@@ -6,7 +6,5 @@
   </head>
   <body>
     <div id="app"></div>
-    <!-- <script src="./main.js"></script> -->
-    <script src="../dist/vue-privilege-menu.js"></script>
   </body>
 </html>