README.md更新

README.md

@@ -1,43 +1,157 @@
-## 版权声明
-* BladeX是一个商业化软件，系列产品知识产权归**上海布雷德网络科技**独立所有
-* 您一旦开始复制、下载、安装或者使用本产品，即被视为完全理解并接受本协议的各项条款
-* 更多详情请看：[BladeX商业授权许可协议](/LICENSE)
-
-## 答疑流程
->1. 遇到问题或Bug
->2. 业务型问题打断点调试尝试找出问题所在
->3. 系统型问题通过百度、谷歌、社区查找解决方案
->4. 未解决问题则进入技术社区进行发帖提问：[https://sns.bladex.vip/](https://sns.bladex.vip/)
->5. 将帖子地址发至商业群，特别简单三言两语就能描述清楚的也可在答疑时间内发至商业群提问
->6. 发帖的时候一定要描述清楚，详细描述遇到问题的**重现步骤**、**报错详细信息**、**相关代码与逻辑**、**使用软件版本**以及**操作系统版本**，否则随意发帖提问将会提高我们的答疑难度。
-
-## 答疑时间
-* 工作日：9:00 ~ 17:00 提供答疑，周末、节假日休息，暂停答疑
-* 请勿**私聊提问**，以免被其他用户的消息覆盖从而无法获得答疑
-* 答疑时间外遇到问题可以将问题发帖至[技术社区](https://sns.bladex.vip/)，我们后续会逐个回复
-
-## 授权范围
-* 专业版：只可用于**个人学习**及**个人私活**项目，不可用于公司或团队，不可泄露给任何第三方
-* 企业版：可用于**企业名下**的任何项目，企业版员工在**未购买**专业版授权前，只授权开发**所在授权企业名下**的项目，**不得将BladeX用于个人私活**
-* 共同遵守：若甲方需要您提供项目源码，则需代为甲方购买BladeX企业授权，甲方购买后续的所有项目都无需再次购买授权
-
-## 商用权益
-* ✔️ 遵守[商业协议](/LICENSE)的前提下，将BladeX系列产品用于授权范围内的商用项目，并上线运营
-* ✔️ 遵守[商业协议](/LICENSE)的前提下，不限制项目数，不限制服务器数
-* ✔️ 遵守[商业协议](/LICENSE)的前提下，将自行编写的业务代码申请软件著作权
-
-## 何为侵权
-* ❌ 不遵守商业协议，私自销售商业源码
-* ❌ 以任何理由将BladeX源码用于申请软件著作权
-* ❌ 将商业源码以任何途径任何理由泄露给未授权的单位或个人
-* ❌ 开发完毕项目，没有为甲方购买企业授权，向甲方提供了BladeX代码
-* ❌ 基于BladeX拓展研发与BladeX有竞争关系的衍生框架，并将其开源或销售
-
-## 侵权后果
-* 情节较轻：第一次发现警告处理
-* 情节较重：封禁账号，踢出商业群，并保留追究法律责任的权利
-* 情节严重：与本地律师事务所合作，以公司名义起诉侵犯计算机软件著作权
-
-## 举报有奖
-* 向官方提供有用线索并成功捣毁盗版个人或窝点，将会看成果给予 500～10000 不等的现金奖励
-* 官方唯一指定QQ：1272154962
+## 表单设计器
+* 参考地址：https://github.com/sscfaith/avue-form-design
+
+## 简介
+
+本项目是一款基于 <a href="https://avuejs.com/" target="_blank">Avue</a> 的表单设计器，拖拽式操作让你快速构建一个表单。
+
+:tada: 基于Bladex的工作流插件已上市。[授权地址](https://bladex.vip/#/market/flow)<br/>
+[表单设计器预览地址](https://form.nutflow.vip)<br>
+[流程设计器预览地址](https://bpmn.nutflow.vip)<br>
+[工作流插件预览地址](https://demo1.nutflow.vip)
+
+## 更新日志
+[更新日志](../../blob/master/CHANGELOG.md)
+
+## 文档及demo项目
+[Wiki](../../wikis)
+
+## 依赖
+
+element-ui 2.13.2+
+
+```sh
+$ npm i element-ui
+```
+
+@smallwei/avue 2.6.16+
+
+```sh
+$ npm i @smallwei/avue
+```
+
+或自行引入cdn
+
+## 安装
+
+### 组件
+
+```sh
+$ npm i @sscfaith/avue-form-design
+或
+$ yarn add @sscfaith/avue-form-design
+```
+
+### 源码
+
+<a href="https://github.com/sscfaith/avue-form-design" target="_blank">github</a> or
+<a href="https://gitee.com/sscgh/avue-from-design" target="_blank">gitee</a>
+
+```sh
+$ yarn
+$ yarn serve
+```
+
+### html
+
+详见examples
+
+## 使用
+
+```
+import AvueFormDesign from '@sscfaith/avue-form-design'
+
+Vue.use(AvueFormDesign)
+```
+
+```
+<avue-form-design style="height: 86vh;"
+                  :options="options"
+                  storage
+                  @submit="handleSubmit"></avue-form-design>
+```
+
+### 属性
+
+| 参数 | 说明 | 类型 | 默认值 |
+| ------ | ------ | ------ | ------ |
+| options | 字段配置 | Object/String | { column: [] } |
+| storage | 开启本地存储功能，防止浏览器刷新丢失json | Boolean | false |
+| asideLeftWidth | 左工具栏宽度 | String/Number | '270px' |
+| asideRightWidth | 右工具栏宽度 | String/Number | '380px' |
+| showAvueDoc（已废弃，请使用toolbar） | 是否显示Avue文档 | Boolean | false |
+| showGithubStar | 是否显示GitHub Star | Boolean | true |
+| toolbar | 顶部工具栏 | Array | ['avue-doc', 'import', 'generate', 'preview', 'clear'] |
+| undoRedo | 是否开启撤销重做功能 | Boolean | true |
+| includeFields | 左侧展示字段 | Array | fieldsConfig.js中配置的字段 |
+| customFields | 自定义组件 | Array | [使用方法](https://github.com/sscfaith/avue-form-design/blob/master/CHANGELOG.md#2020-09-22) |
+
+### options字段配置
+
+<a href="https://avuejs.com/doc/form/form-doc" target="_blank">Avue文档</a>
+
+| 属性 | 说明 | 类型 | 可选值 | 默认值 |
+| ------| ------ | ------ | ------ | ------ |
+| column | Avue字段 | Array | - | [] |
+| labelPosition | 字段位置 |  String | 'left'/'center'/'right' | - |
+| labelWidth | 字段宽度 | Number | - | - |
+| gutter | 字段间隔 | Number | - | 0 |
+| menuBtn | 表单按钮 | Boolean | true/false | true |
+| submitBtn | 显示提交按钮 | Boolean | true/false | true |
+| submitText | 提交按钮文本 | String | - | '提交' |
+| emptyBtn | 显示清空按钮 | Boolean | true/false | true |
+| emptyText | 清空按钮文本 | String | - | '清空' |
+| tabs | 多分组转标签 | Boolean | true/false | false |
+| detail | 详情模式 | Boolean | true/false | false |
+| readonly | 全局只读 | Boolean | true/false | false |
+| disabled | 全局禁用 | Boolean | true/false | false |
+
+### 事件
+
+| 名称 | 说明 | 回调参数 |
+| ------ | ------ | ------ |
+| submit | 生成json回调 | 当前配置的json |
+
+### 方法
+
+| 名称 | 说明 | 参数 | 返回 |
+| ------ | ------ | ------ | ------ |
+| getData | 获取当前编辑器的JSON | type: 'string'/'json' | Promise |
+
+### 插槽
+| 名称 | 说明 |
+| ------ | ------ | 
+| toolbar | 顶部工具栏右侧插槽 | 
+| toolbar-left | 顶部工具栏左侧插槽 | 
+
+### Avue插件
+
+#### 富文本
+
+```
+import AvueUeditor from 'avue-plugin-ueditor'
+
+Vue.use(AvueUeditor)
+```
+
+## 打包
+
+### 组件
+
+```sh
+$ yarn lib
+```
+
+### 源码
+
+```sh
+$ yarn build
+```
+
+## 捐赠
+如果你觉得本项目帮助到你的话，可以给作者买杯咖啡。
+<img src="https://form.beta.kim/donate.png">
+
+## License
+
+<a href="https://opensource.org/licenses/MIT" target="_blank">MIT</a>