tianheng-ui 0.1.80 → 0.1.82

package/README.md

@@ -1,15 +1,72 @@
-# Install
+# tianheng-ui
 
-> npm i tianheng-ui
+<p>
+  <a href="https://github.com/vuejs/vue">
+    <img src="https://img.shields.io/badge/vue-2.5.11-brightgreen.svg" alt="vue">
+  </a>
+  
+  <a href="https://github.com/ElemeFE/element">
+    <img src="https://img.shields.io/badge/element--ui-2.15.6-brightgreen.svg" alt="element-ui">
+  </a>
+  
+  <a href="https://www.npmjs.com/package/form-making">
+    <img src="https://img.shields.io/npm/dt/tianheng-ui" alt="downloads">
+  </a>
+  
+  <a href="https://github.com/GavinZhuLei/vue-form-making/blob/master/LICENSE">
+    <img src="https://img.shields.io/github/license/GavinZhulei/vue-form-making" alt="license">
+  </a>
+</p>
 
-## Quick Start
+基于 [vue](https://github.com/vuejs/vue) 和 [element-ui](https://github.com/ElemeFE/element) 实现的可视化表单设计器，使用了最新的前端技术栈，内置了 i18n 国际化解决方案，可以让表单开发简单而高效。
 
-``` bash
-import TianhengUI from "tianheng-ui";
-import 'tianheng-ui/lib/theme-chalk/index.scss';
-Vue.use(TianhengUI);
+- [在线预览](https://tianhengui.demo.tianhengyun.com)
+- [开发指南](https://tianhengui.demo.tianhengyun.com/guide)
+- [更新日志](https://tianhengui.demo.tianhengyun.com/component/changelog)
+- [组件](https://tianhengui.demo.tianhengyun.com/component/installation)
+  - [WorkFlow](https://tianhengui.demo.tianhengyun.com/component/workflow) 工作流（基于 [bpmn-js](https://www.npmjs.com/package/bpmn-js) 实现业务流程设计器，可自定义流程节点：指定人员、指定部门、直属领导、联系多级主管、发起人自选、发起人自己，可支持根据业务字段进行条件判断。）
+  - [CodeEditor](https://tianhengui.demo.tianhengyun.com/component/codeEditor) 代码编辑器（基于 [ace-builds](https://www.npmjs.com/package/ace-builds) 实现的代码编辑器）
+  - [VueEditor](https://tianhengui.demo.tianhengyun.com/component/vueEditor) 富文本编辑器（基于 [vue2-editor](https://www.npmjs.com/package/vue2-editor) 实现的富文本编辑器）
+  - [FormMaking](https://tianhengui.demo.tianhengyun.com/component/formMaking) 表单设计器（基于可视化操作快速设计出表单页面）
+  - [FormGenerate](https://tianhengui.demo.tianhengyun.com/component/formGenerate) 表单渲染器（根据设计器中获取的配置 json 数据，快速渲染出表单页面）
+  - [TableMaking](https://tianhengui.demo.tianhengyun.com/component/tableMaking) 列表设计器（基于可视化操作快速设计出列表页面）
+  - [TableGenerate](https://tianhengui.demo.tianhengyun.com/component/tableGenerate/1602183544547655681) 列表渲染器（根据设计器中获取的配置 json 数据，快速渲染出列表页面）
+
+## FormMaking 特性
+
+```html
+<!-- 表单设计器 -->
+<th-form-making :config="formConfig"></th-form-making>
+<!-- 表单渲染器 -->
+<th-form-generate :config="formConfig" :value="formValue"></th-form-generate>
 ```
 
-# 官网
+- 可视化配置页面
+- 提供栅格布局，并采用 flex 实现对齐
+- 提供布局容器，并且可以相互嵌套（栅格、表格、标签页）
+- 一键预览配置的效果
+- 一键生成配置 json 数据
+- 一键生成代码，立即可运行
+- 提供自定义组件满足用户自定义需求
+- 提供远端数据接口，方便用户需要异步获取数据加载
+- 提供动作事件，可以让表单更加灵活配置
+- 提供功能强大的高级组件
+- 提供多维数据设计，支持表单结果数据内链
+- 支持表单验证
+- 快速获取表单数据
+
+[更多介绍](https://tianhengui.demo.tianhengyun.com/document/formMaking/introduce)
+
+### Installation
 
-https://tianhengui.demo.tianhengyun.com/
+```shell
+npm install tianheng-ui
+```
+
+### Quick Start
+
+```shell
+import TianhengUI from "tianheng-ui";
+import 'tianheng-ui/lib/theme-chalk/index.scss';
+Vue.use(TianhengUI);
+```