Skip to content

Commit c9aa651

Browse files
committed
docs: readme update
1 parent 3dec75f commit c9aa651

File tree

8 files changed

+181
-3
lines changed

8 files changed

+181
-3
lines changed

.github/assets/banner.svg

Lines changed: 37 additions & 0 deletions
Loading

.github/assets/discord.svg

Lines changed: 11 additions & 0 deletions
Loading

.github/assets/github.svg

Lines changed: 9 additions & 0 deletions
Loading

.github/assets/linkedin.svg

Lines changed: 9 additions & 0 deletions
Loading

.github/assets/nuxt.svg

Lines changed: 11 additions & 0 deletions
Loading

.github/assets/vite.svg

Lines changed: 27 additions & 0 deletions
Loading

.github/assets/x.svg

Lines changed: 11 additions & 0 deletions
Loading

README.md

Lines changed: 66 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,67 @@
1-
# Welcome to Vueform Builder
1+
[![Vuefom](./.github/assets/banner.svg)](https://builder.vueform.com?cid=builder)
22

3-
Please visit our website for instruction on getting started:
4-
https://builder.vueform.com/docs/installation
3+
# Vueform Builder
4+
5+
<p>
6+
<a href="https://www.npmjs.com/package/@vueform/builder" target="_blank"><img alt="npm" src="https://img.shields.io/npm/dt/@vueform/builder?color=%2317c495"></a>
7+
<a href="https://www.npmjs.com/package/@vueform/builder" target="_blank"><img alt="npm" src="https://img.shields.io/npm/v/@vueform/builder?color=%2317c495"></a>
8+
</p>
9+
10+
Drag and drop form builder for [Vueform](https://github.com/vueform/vueform).
11+
12+
Enable developers & non-tech workforce to build even the most complex forms without coding:
13+
14+
- User friendly drag and drop form builder
15+
- Export forms as native Vue components
16+
- Save/load/render forms as JSON and save to database
17+
- Custom elements and config panels
18+
- Built-in theme builder
19+
- Customize the UI
20+
- Use it online or on your localhost
21+
- Integrate it into any project
22+
23+
## Get Started
24+
25+
Jump right into the project with ease using one of our boilerplates.
26+
27+
<table>
28+
<tbody>
29+
<tr>
30+
<td>
31+
<h4><img src="./.github/assets/vite.svg" height="21" /> Vite</h4>
32+
</td>
33+
<td>
34+
<h4><a href="https://github.com/vueform/builder-vite-starter">@vueform/builder-vite-starter</a></h4>
35+
</td>
36+
</tr>
37+
<tr>
38+
<td>
39+
<h4><img src="./.github/assets/nuxt.svg" height="21" /> Nuxt</h4>
40+
</td>
41+
<td>
42+
<h4><a href="https://github.com/vueform/builder-nuxt-starter">@vueform/builder-nuxt-starter</a></h4>
43+
</td>
44+
</tr>
45+
</tbody>
46+
</table>
47+
48+
#### Manual Installation
49+
50+
To manually install Vueform, use our [Installation Wizard](https://builder.vueform.com/docs/installation?cid=builder). This wizard will guide you through the necessary steps for a hassle-free setup.
51+
52+
## Documentation
53+
54+
For a detailed understanding of Vueform, its features, and how to use them, refer to our [Documentation](https://builder.vueform.com/docs/saving?cid=builder).
55+
56+
## Follow Us
57+
58+
<p>
59+
<a href="https://discord.gg/WhX2nG6GTQ" target="_blank"><img src="./.github/assets/discord.svg" alt="Vueform on Discord" title="Vueform on Discord"></a>&nbsp;&nbsp;
60+
<a href="https://twitter.com/vueform" target="_blank"><img src="./.github/assets/x.svg" alt="Vueform on X" title="Vueform on X"></a>&nbsp;&nbsp;
61+
<a href="https://www.linkedin.com/company/vueform" target="_blank"><img src="./.github/assets/linkedin.svg" alt="Vueform on LinkedIn" title="Vueform on LinkedIn"></a>&nbsp;&nbsp;
62+
<a href="https://github.com/vueform" target="_blank"><img src="./.github/assets/github.svg" alt="Vueform on GitHub" title="Vueform on GitHub"></a>
63+
</p>
64+
65+
## License
66+
67+
[LICENSE](https://vueform.com/license-agreement?cid=builder)

0 commit comments

Comments
 (0)