From 0e2988444f7d172b39da7a84a00c052bcbba9999 Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Sun, 8 Mar 2020 10:20:02 -0400 Subject: [PATCH 1/5] adds gifs to readme and updates some language --- README.md | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 3c9f20e..02e2bd4 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,16 @@ ### 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: + +:-------------------------:|:-------------------------: +![uploads](https://assets.wearebraid.com/vue-formulate/formulate-uploads.gif) | ![form demo](https://assets.wearebraid.com/vue-formulate/formulate-form.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 ``` +Collecting multiple `FormulateInput` elements within a single `FormulateForm` element (even deeply nested) allows you to `v-model` your entire form. + +### Vue Formulate lets you: ✓ Create any input element with a single component
-✓ Supports Vue `v-model` [binding](https://vueformulate.com/guide/#model-binding)
+✓ 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
-✓ 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) +✓ 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 [documentation website](https://vueformulate.com). +There's a lot more available to read at the comprehensive [documentation website](https://vueformulate.com). From de7168d643ff8ebf66ba23f49ba9e3b8e7049251 Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Sun, 8 Mar 2020 10:24:37 -0400 Subject: [PATCH 2/5] adjusts table syntax for readme --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 02e2bd4..f496157 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,9 @@ 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. - -:-------------------------:|:-------------------------: -![uploads](https://assets.wearebraid.com/vue-formulate/formulate-uploads.gif) | ![form demo](https://assets.wearebraid.com/vue-formulate/formulate-form.gif) - +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? From fc8ad9978c13a95e27955aaf1d4f1cc2baae95a9 Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Mon, 9 Mar 2020 10:27:33 -0400 Subject: [PATCH 3/5] Reorders content on the readme to get feature list to the top --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index f496157..bc9664e 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,20 @@ 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 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) @@ -36,17 +50,3 @@ The syntax is what developers would expect. To create an input you use the `Form ``` Collecting multiple `FormulateInput` elements within a single `FormulateForm` element (even deeply nested) allows you to `v-model` your entire form. - -### 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). From 21defec04f8cf938efdac5ea2ba178f2e2840a36 Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Mon, 9 Mar 2020 10:28:31 -0400 Subject: [PATCH 4/5] ends readme on link to documentation site --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bc9664e..3636fd8 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,6 @@ form and field validation, file uploads, form generation, single-element inputs ✓ 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 :-------------------------:|:------------------------------: @@ -50,3 +49,5 @@ The syntax is what developers would expect. To create an input you use the `Form ``` 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 comprehensive [documentation website](https://vueformulate.com). From a355ce804301baeb6c60e614a50b348e8f52395f Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Mon, 9 Mar 2020 10:29:49 -0400 Subject: [PATCH 5/5] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 3636fd8..d72674f 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ form and field validation, file uploads, form generation, single-element inputs ✓ 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 :-------------------------:|:------------------------------: @@ -50,4 +51,6 @@ The syntax is what developers would expect. To create an input you use the `Form Collecting multiple `FormulateInput` elements within a single `FormulateForm` element (even deeply nested) allows you to `v-model` your entire form. +### Comprehensive Documentation + There's a lot more available to read at the comprehensive [documentation website](https://vueformulate.com).