diff --git a/README.md b/README.md index 51b4a6a..262d6a9 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,29 @@ ### 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 and a single-element -fields with labels, help text, error messages, placeholders and lots more. +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. -The syntax is what developers would expect: +### 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) + +### 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: ```vue ``` -✓ Create any input element with a single component
-✓ Supports Vue `v-model` [binding](https://vueformulate.com/guide/#model-binding)
-✓ [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
-✓ Easy to add field labels
-✓ Easy to add help text
-✓ Easy to add [form validation](https://vueformulate.com/guide/validation)
-✓ Easy to add [custom validation](https://vueformulate.com/guide/validation/#custom-validation-rules) rules
-✓ Easy to modify [validation messages](https://vueformulate.com/guide/validation/#customize-validation-messages)
-✓ Easy to add [custom inputs](https://vueformulate.com/guide/custom-inputs)
-✓ Backend response [error handling](https://vueformulate.com/guide/forms/error-handling) +Collecting multiple `FormulateInput` elements within a single `FormulateForm` element (even deeply nested) allows you to `v-model` your entire form. -There's a lot more available to read at the [documentation website](https://vueformulate.com). +### Comprehensive Documentation + +There's a lot more available to read at the comprehensive [documentation website](https://vueformulate.com).