Skip to content

Commit fe51426

Browse files
committed
docs: update guide
1 parent 82c9553 commit fe51426

File tree

2 files changed

+86
-6
lines changed

2 files changed

+86
-6
lines changed

README.md

+24-6
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,21 @@
88

99
Build powerful vue form with JSON schema and composition api. Any custom input components and popular ui frameworks such as [Element UI](https://element.eleme.cn/), [View UI](https://www.iviewui.com/), [Ant Design Vue](https://www.antdv.com/) are supported.
1010

11-
## Example
12-
13-
[:zap: Live Preview](https://openfext.github.io/vue-admin-next/#/form/form-builder) | [:book: Element UI Storybook](https://openfext.github.io/vue-form-builder/?path=/story/formbuilder-element-ui--basic-usage) | [:book: View UI Storybook](https://openfext.github.io/vue-form-builder/?path=/story/formbuilder-view-ui--basic-usage) | [:book: Ant Design Storybook](https://openfext.github.io/vue-form-builder/?path=/story/formbuilder-ant-design-vue--basic-usage)
14-
15-
![Screen Capture](https://github.com/openfext/vue-form-builder/raw/develop/.github/preview.gif)
11+
:us: English | [:cn: 简体中文](README.zh-CN.md)
1612

17-
## Core Features
13+
## Features
1814

1915
- :tv: **Powerful** - use composition api to manage complex form state
2016
- :camera: **Flexible** - support any custom input components
2117
- :watch: **Adaptable** - different ui frameworks can be used out of the box through the adapters
2218
- :radio: **Reliable** - has been used in multiple applications in the production environment
2319

20+
## Example
21+
22+
[:zap: Live Preview](https://openfext.github.io/vue-admin-next/#/form/form-builder) | [:book: Element UI Storybook](https://openfext.github.io/vue-form-builder/?path=/story/formbuilder-element-ui--basic-usage) | [:book: View UI Storybook](https://openfext.github.io/vue-form-builder/?path=/story/formbuilder-view-ui--basic-usage) | [:book: Ant Design Storybook](https://openfext.github.io/vue-form-builder/?path=/story/formbuilder-ant-design-vue--basic-usage)
23+
24+
![Screen Capture](https://github.com/openfext/vue-form-builder/raw/develop/.github/preview.gif)
25+
2426
## Docs
2527

2628
### 🇨🇳 Chinese
@@ -34,6 +36,22 @@ Build powerful vue form with JSON schema and composition api. Any custom input c
3436

3537
WIP...
3638

39+
## Contacts
40+
41+
Welcome to join the group chat to discuss project issues and front-end technologies 💬
42+
43+
### QQ
44+
45+
ChatID: 667576147
46+
47+
![QQGroupQRCode](https://user-images.githubusercontent.com/2902215/84306575-3e785280-ab8e-11ea-8c53-af8620b5cc69.JPG)
48+
49+
### WeChat Group
50+
51+
Add the author's WeChat to get into the group:
52+
53+
![WeChatQRCode](https://user-images.githubusercontent.com/2902215/84306570-3c15f880-ab8e-11ea-9041-8ea4ccbaa772.JPG)
54+
3755
## Built With
3856

3957
- [Vue.js](https://github.com/vuejs/vue)

README.zh-CN.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Vue Form Builder
2+
3+
[![CircleCI](https://circleci.com/gh/openfext/vue-use.svg?style=svg)](https://circleci.com/gh/openfext/vue-use)
4+
[![codecov](https://codecov.io/gh/openfext/vue-form-builder/branch/develop/graph/badge.svg)](https://codecov.io/gh/openfext/vue-form-builder)
5+
[![License](https://img.shields.io/npm/l/@fext/vue-form-builder.svg)](https://www.npmjs.com/package/@fext/vue-form-builder)
6+
[![Version](https://img.shields.io/npm/v/@fext/vue-form-builder.svg)](https://www.npmjs.com/package/@fext/vue-form-builder)
7+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/openfext/vue-form-builder)
8+
9+
Vue Form Builder 是一个基于 JSON Schema 和 Vue Composition API 的动态表单构建器。任意自定义表单组件及主流 UI 框架例如 [Element UI](https://element.eleme.cn/)[View UI](https://www.iviewui.com/)[Ant Design Vue](https://www.antdv.com/) 等都能够轻松支持。
10+
11+
:cn: 简体中文 | [:us: English](README.md)
12+
13+
## 主要特性
14+
15+
- :tv: **强大** - 通过 Vue Composition API 管理表单状态,再也不用野路子了
16+
- :camera: **灵活** - 支持任意、任意、任意自定义表单组件,重要的事情说三遍
17+
- :watch: **兼容** - 多种主流 UI 框架开箱即配,就等你来
18+
- :radio: **可靠** - 多个生产环境的应用已在使用,还在等什么呢
19+
20+
## 在线示例
21+
22+
[:zap: Live Preview](https://openfext.github.io/vue-admin-next/#/form/form-builder) | [:book: Element UI Storybook](https://openfext.github.io/vue-form-builder/?path=/story/formbuilder-element-ui--basic-usage) | [:book: View UI Storybook](https://openfext.github.io/vue-form-builder/?path=/story/formbuilder-view-ui--basic-usage) | [:book: Ant Design Storybook](https://openfext.github.io/vue-form-builder/?path=/story/formbuilder-ant-design-vue--basic-usage)
23+
24+
![Screen Capture](https://github.com/openfext/vue-form-builder/raw/develop/.github/preview.gif)
25+
26+
## 参考文档
27+
28+
- [介绍](https://openfext.github.io/docs/zh/vue-form-builder/intro.html)
29+
- [指南](https://openfext.github.io/docs/zh/vue-form-builder/guide/start.html)
30+
- [API Reference](https://openfext.github.io/docs/zh/vue-form-builder/api/component.html)
31+
- [Config Reference](https://openfext.github.io/docs/zh/vue-form-builder/config/schema.html)
32+
33+
## 联系方式
34+
35+
欢迎加入群聊讨论项目问题和前端技术 💬
36+
37+
### QQ
38+
39+
群号:667576147
40+
41+
![QQGroupQRCode](https://user-images.githubusercontent.com/2902215/84306575-3e785280-ab8e-11ea-8c53-af8620b5cc69.JPG)
42+
43+
### 微信群
44+
45+
加作者微信进群:
46+
47+
![WeChatQRCode](https://user-images.githubusercontent.com/2902215/84306570-3c15f880-ab8e-11ea-9041-8ea4ccbaa772.JPG)
48+
49+
## 使用技术
50+
51+
- [Vue.js](https://github.com/vuejs/vue)
52+
- [Vue Use](https://github.com/openfext/vue-use)
53+
- [Vee Validate](https://github.com/logaretm/vee-validate)
54+
- [ElementUI](https://github.com/ElemeFE/element)
55+
- [View UI](https://github.com/view-design/ViewUI)
56+
- [Ant Design Vue](https://github.com/vueComponent/ant-design-vue)
57+
58+
## License
59+
60+
[MIT](http://opensource.org/licenses/MIT)
61+
62+
Copyright (c) 2018 - present, Felix Yang

0 commit comments

Comments
 (0)