@gonsin/gview 1.0.2-alpha.0 → 1.1.0

package/README.md

@@ -1,26 +1,66 @@
-# gview
-
-## Project setup
-```
-npm install
-```
-
-### Compiles and hot-reloads for development
-```
-npm run serve
-```
-
-### Compiles and minifies for production
-```
-npm run build
-```
-
-### Run your tests
-```
-npm run test
-```
-
-### Lints and fixes files
-```
-npm run lint
-```
+# GView
+
+## 安装依赖
+
+```sh
+npm install
+```
+
+## 项目测试
+
+```sh
+npm run serve
+```
+
+## 项目打包
+
+```sh
+npm run build
+```
+
+## 项目发布
+
+```sh
+npm publish
+```
+
+## 使用方法：
+
+详细参考 `example` 项目。
+
+`main.js` 配置：
+
+```js
+// 引入 GView 标签
+import GView from "@gonsin/gview";
+Vue.use(GView, { store });
+
+new Vue({
+    router,
+    render: (h) => h(App),
+}).$mount("#app");
+```
+
+根据开发修改接口的地址：
+
+```js
+proxy: {
+  "/api": {
+    target: "http://192.168.2.192:8088",
+    changeOrigin: true,
+    disableHostCheck: false, //  新增该配置项
+  },
+  "/restapi": {
+    target: "http://192.168.2.192:8088",
+    changeOrigin: true,
+    disableHostCheck: false, //  新增该配置项
+  },
+  // 配置websocket开发时代理
+  "/gview/websocket": {
+    target: "ws://192.168.2.192:8088",
+    changeOrigin: true,
+    disableHostCheck: false, //  新增该配置项
+  },
+},
+
+```