Skip to content

Commit 481220f

Browse files
committed
docs: update guide
1 parent 13ecd35 commit 481220f

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44
[![codecov](https://codecov.io/gh/openfext/vue-form-builder/branch/develop/graph/badge.svg)](https://codecov.io/gh/openfext/vue-form-builder)
55
[![License](https://img.shields.io/npm/l/@fext/vue-form-builder.svg)](https://www.npmjs.com/package/@fext/vue-form-builder)
66
[![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)
78

8-
Build powerful vue form with JSON schema and composition api. Any custom input components and popular ui frameworks such as Element UI are supported.
9+
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.
910

1011
## Example
1112

12-
[:zap: Live Preview](https://openfext.github.io/vue-admin-next/#/form/form-builder) | [:book: Storybook](https://openfext.github.io/vue-form-builder)
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)
1314

1415
![Screen Capture](https://github.com/openfext/vue-form-builder/raw/develop/.github/preview.gif)
1516

@@ -20,9 +21,13 @@ Build powerful vue form with JSON schema and composition api. Any custom input c
2021
- :watch: **Adaptable** - different ui frameworks can be used out of the box through the adapters
2122
- :radio: **Reliable** - has been used in multiple applications in the production environment
2223

24+
## Docs
25+
26+
[Complete API Reference](http://openfext.github.io/docs/vue-form-builder)
27+
2328
## Quick Start
2429

25-
First you need a vue application like [Vue Admin Next](https://github.com/openfext/vue-admin-next).
30+
Let ’s take Element UI as an example, first you need a vue application like [Vue Admin Next](https://github.com/openfext/vue-admin-next).
2631

2732
### Install
2833

@@ -123,10 +128,6 @@ export default {
123128
};
124129
```
125130

126-
## Docs
127-
128-
TODO
129-
130131
## Built With
131132

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

0 commit comments

Comments
 (0)