diff --git a/README.md b/README.md index 2e27cae..e39f372 100644 --- a/README.md +++ b/README.md @@ -11,76 +11,74 @@ Documentation Website

-### What is Vue Formulate? +## What is Vue Formulate? -Vue Formulate is the easiest way to build forms using Vue. Key features include -form and field validation, file uploads, form generation, single-element inputs that support labels, help text, error messages, placeholders and more, and [comprehensive documentation](https://vueformulate.com) for use within your own projects. +Vue Formulate is the easiest way to build forms with Vue. Please read the [comprehensive documentation](https://vueformulate.com) for live code examples and guidance on using Vue Formulate in your own projects. -### Vue Formulate lets you: -✓ Create any input element with a single component
-✓ Use `v-model` [binding](https://vueformulate.com/guide/#model-binding) on fields and entire forms
-✓ [Re-populate an entire form](https://vueformulate.com/guide/forms/#setting-initial-values) from a single object
-✓ [Generate a form](https://vueformulate.com/guide/forms/#generating-forms) using json
-✓ Easily add field labels
-✓ Easily add help text
-✓ Easily add [form validation](https://vueformulate.com/guide/validation)
-✓ Easily add [custom validation](https://vueformulate.com/guide/validation/#custom-validation-rules) rules
-✓ Easily create custom [validation messages](https://vueformulate.com/guide/validation/#customize-validation-messages)
-✓ Easily create [custom inputs](https://vueformulate.com/guide/custom-inputs) +

-There's a lot more available to read at the comprehensive [documentation website](https://vueformulate.com). -v-model an entire form | Well-considered file uploads -:-------------------------:|:------------------------------: -![v-model an entire form](https://assets.wearebraid.com/vue-formulate/formulate-form.gif) | ![well-considered file uploads](https://assets.wearebraid.com/vue-formulate/formulate-uploads.gif) + + + + + + + + + + + + + + + + +
+

Key features

+
+

😎 Developer happiness

+

Forms are everywhere, yet surprisingly tedious to author — well, not anymore. Vue Formulate provides a powerful and flexible API to developers that makes complex form creation a breeze.

+ 		+

☝️ A single input element

+

With Vue Formulate you don't need to remember the names of a dozen components — all form elements are created with a single component. Easy!

+
+

💪 Grouped fields

+

Vue Formulate ships with repeatable field groups out of the box. Create complex UIs such as multi-person booking forms with ease.

+ 		+

🎯 Built-in validation

+

Ridiculously easy validation out-of-the-box to handle 95% of use-cases. Help text, validation rules, and validation messages are simple props. Need more? You can add custom validations too.

+
+

🔌 Plugin system

+

Extend Vue Formulate's functionality or reuse custom inputs, validation rules, and messages across projects by tapping into the plugin system. Make your plugin open source to share with others!

+ 		+

✨ Generate forms

+

Generate an entire form from a JSON string. Because Vue Formulate uses a single input component, you can easily loop through an array and dynamically generate a form.

+
-### How is Vue Formulate used? -The syntax is what developers would expect. To create an input you use the `FormulateInput` element and provide it with a few props: +These features and many more are covered thoroughly at the [documentation website](https://vueformulate.com). -```vue - -``` +

-Collecting multiple `FormulateInput` elements within a single `FormulateForm` element (even deeply nested) allows you to `v-model` your entire form. -### Comprehensive Documentation +## Contributing +Vue Formulate is and always will be _free_ and _open source_. There are many ways available for you to [contribute to Vue Formulate](https://vueformulate.com/guide/contributing/). -There's a lot more available to read at the comprehensive [documentation website](https://vueformulate.com). +#### Core Codebase Contributors -## Contributors +This project exists thanks to all the people who volunteer their time to [contribute](https://vueformulate.com/guide/contributing/) -### Code Contributors + -This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. - +#### Localization Contributors -### Financial Contributors +Vue Formulate is translated into different languages by volunteer native language speakers. Localizations are located in the [Vue Formulate Internationalization repo](https://github.com/wearebraid/vue-formulate-i18n). -Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/vue-formulate/contribute)] + -#### Individuals +## License - +[MIT](https://opensource.org/licenses/MIT) -#### Organizations - -Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/vue-formulate/contribute)] - - - - - - - - - - - +Copyright (c) 2020-present, [Braid LLC](https://www.wearebraid.com/) \ No newline at end of file