From d08ff43d38b448acf28a4f9f5728a3a24b396366 Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Sun, 17 May 2020 10:43:33 -0400 Subject: [PATCH 1/9] refactor readme to better reflect documentation website --- README.md | 53 +++++++++++++---------------------------------------- 1 file changed, 13 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 2e27cae..7edbfee 100644 --- a/README.md +++ b/README.md @@ -13,58 +13,31 @@ ### 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 using Vue. Please read the [comprehensive documentation](https://vueformulate.com) for guidance on using Vue Formulate 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). +|

Key features

| | +|:-------------|:----------| +|

😎 Developer happiness

Forms are everywhere, yet surprisingly tedious to author — well, not anymore. Vue Formulate provides a [powerful and flexible API](https://vueformulate.com/guide/inputs/#all-options) 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](https://vueformulate.com/guide/#inputs). Easy! | +|

💪 Grouped fields

Vue Formulate ships with [repeatable field groups](https://vueformulate.com/guide/inputs/types/group/#repeatable-groups) out of the box. Create complex UIs such as multi-person booking forms with ease. |

🎯 Built-in validation

Ridiculously easy [validation](https://vueformulate.com/guide/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](https://vueformulate.com/guide/plugins/#creating-a-new-plugin). Make your plugin open source to share with others! |

✨ Generate forms

[Generate an entire form](https://vueformulate.com/guide/forms/#generating-forms) from a JSON string. Because Vue Formulate uses a single input component, you can easily loop through an array and dynamically generate a form. | -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? +These features and many more are thoroughly covered an the [documentation website](https://vueformulate.com). -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. - -### Comprehensive Documentation - -There's a lot more available to read at the comprehensive [documentation website](https://vueformulate.com). - -## Contributors +## 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/). ### Code Contributors -This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. +This project exists thanks to all the people who take the time to [contribute](https://vueformulate.com/guide/contributing/). + ### Financial Contributors -Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/vue-formulate/contribute)] +Become a financial contributor and help us sustain our the development of Vue Formulate. [[Contribute](https://opencollective.com/vue-formulate/contribute)] #### Individuals @@ -72,7 +45,7 @@ Become a financial contributor and help us sustain our community. [[Contribute]( #### 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)] +Support this project with your organization. Your organizations's logo will show up here with a link to your website. [[Contribute](https://opencollective.com/vue-formulate/contribute)] From 351047bc4f053b870b88cc524bd41b004c3d9cd7 Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Sun, 17 May 2020 11:01:08 -0400 Subject: [PATCH 2/9] use HTML for feature table in readme for better style control --- README.md | 44 ++++++++++++++++++++++++++++++++++++++------ 1 file changed, 38 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7edbfee..783f625 100644 --- a/README.md +++ b/README.md @@ -16,14 +16,46 @@ Vue Formulate is the easiest way to build forms using Vue. Please read the [comprehensive documentation](https://vueformulate.com) for guidance on using Vue Formulate within your own projects. -|

Key features

| | -|:-------------|:----------| -|

😎 Developer happiness

Forms are everywhere, yet surprisingly tedious to author — well, not anymore. Vue Formulate provides a [powerful and flexible API](https://vueformulate.com/guide/inputs/#all-options) 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](https://vueformulate.com/guide/#inputs). Easy! | -|

💪 Grouped fields

Vue Formulate ships with [repeatable field groups](https://vueformulate.com/guide/inputs/types/group/#repeatable-groups) out of the box. Create complex UIs such as multi-person booking forms with ease. |

🎯 Built-in validation

Ridiculously easy [validation](https://vueformulate.com/guide/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](https://vueformulate.com/guide/plugins/#creating-a-new-plugin). Make your plugin open source to share with others! |

✨ Generate forms

[Generate an entire form](https://vueformulate.com/guide/forms/#generating-forms) from a JSON string. Because Vue Formulate uses a single input component, you can easily loop through an array and dynamically generate a form. | + + + + + + + + + + + + + + + + +
+

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.

+
-These features and many more are thoroughly covered an the [documentation website](https://vueformulate.com). +These features and many more are thoroughly covered at the [documentation website](https://vueformulate.com). ## Contributing From b2a358f91f70b79069ad9c0bc2f4e4179c873f19 Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Sun, 17 May 2020 11:03:52 -0400 Subject: [PATCH 3/9] remove financial contributors sections --- README.md | 25 +------------------------ 1 file changed, 1 insertion(+), 24 deletions(-) diff --git a/README.md b/README.md index 783f625..7b307c7 100644 --- a/README.md +++ b/README.md @@ -65,27 +65,4 @@ Vue Formulate is and always will be free and open source. There are many ways av This project exists thanks to all the people who take the time to [contribute](https://vueformulate.com/guide/contributing/). - - -### Financial Contributors - -Become a financial contributor and help us sustain our the development of Vue Formulate. [[Contribute](https://opencollective.com/vue-formulate/contribute)] - -#### Individuals - - - -#### Organizations - -Support this project with your organization. Your organizations's logo will show up here with a link to your website. [[Contribute](https://opencollective.com/vue-formulate/contribute)] - - - - - - - - - - - + \ No newline at end of file From 705ad2e7d4209f79562dfcb7cf35bda4e4696570 Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Sun, 17 May 2020 11:09:32 -0400 Subject: [PATCH 4/9] adds cta to read the docs --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 7b307c7..8a94ad5 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,8 @@ Vue Formulate is the easiest way to build forms using Vue. Please read the [comprehensive documentation](https://vueformulate.com) for guidance on using Vue Formulate within your own projects. +

+ @@ -57,6 +59,8 @@ Vue Formulate is the easiest way to build forms using Vue. Please read the [comp These features and many more are thoroughly covered at the [documentation website](https://vueformulate.com). +

+ ## 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/). From 8cfef3300e6d5ed5ee36ec147e20fa84da695f42 Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Sun, 17 May 2020 11:21:04 -0400 Subject: [PATCH 5/9] slight text adjuestments and addition of license section --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8a94ad5..73ccade 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ ### What is Vue Formulate? -Vue Formulate is the easiest way to build forms using Vue. Please read the [comprehensive documentation](https://vueformulate.com) for guidance on using Vue Formulate 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.

@@ -57,16 +57,22 @@ Vue Formulate is the easiest way to build forms using Vue. Please read the [comp
-These features and many more are thoroughly covered at the [documentation website](https://vueformulate.com). +These features and many more are covered thoroughly at the [documentation website](https://vueformulate.com).

## 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/). +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/). ### Code Contributors This project exists thanks to all the people who take the time to [contribute](https://vueformulate.com/guide/contributing/). - \ No newline at end of file + + +## License + +[MIT](https://opensource.org/licenses/MIT) + +Copyright (c) 2020-present, Braid LLC \ No newline at end of file From 0fc866a8e0f411f8d156e1ccf6d3805b33da6838 Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Sun, 17 May 2020 11:21:53 -0400 Subject: [PATCH 6/9] adds link to braid website --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 73ccade..6db9018 100644 --- a/README.md +++ b/README.md @@ -75,4 +75,4 @@ This project exists thanks to all the people who take the time to [contribute](h [MIT](https://opensource.org/licenses/MIT) -Copyright (c) 2020-present, Braid LLC \ No newline at end of file +Copyright (c) 2020-present, [Braid LLC](https://www.wearebraid.com/) \ No newline at end of file From 4c5e491d4bb3a6a39ed1564b44e2b9b211245c72 Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Sun, 17 May 2020 11:23:47 -0400 Subject: [PATCH 7/9] tighten up contributors section --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 6db9018..a0eea7e 100644 --- a/README.md +++ b/README.md @@ -63,11 +63,7 @@ These features and many more are covered thoroughly at the [documentation websit ## 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/). - -### Code Contributors - -This project exists thanks to all the people who take the time to [contribute](https://vueformulate.com/guide/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/). This project exists thanks to all the people who volunteer their time to [contribute](https://vueformulate.com/guide/contributing/). From cb769426c0284f59c235760e851200bbebee38fb Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Sun, 17 May 2020 11:28:17 -0400 Subject: [PATCH 8/9] change intro heading to h2 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a0eea7e..86e7da6 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Documentation Website

-### What is Vue Formulate? +## What is Vue Formulate? 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. From be7f61f53ec57b229a09677ae9b790479f8bac99 Mon Sep 17 00:00:00 2001 From: Andrew Boyd Date: Sun, 17 May 2020 13:46:39 -0400 Subject: [PATCH 9/9] update readme to include localization contributors --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 86e7da6..e39f372 100644 --- a/README.md +++ b/README.md @@ -63,9 +63,19 @@ These features and many more are covered thoroughly at the [documentation websit ## 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/). This project exists thanks to all the people who volunteer their time to [contribute](https://vueformulate.com/guide/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/). - +#### Core Codebase Contributors + +This project exists thanks to all the people who volunteer their time to [contribute](https://vueformulate.com/guide/contributing/) + + + +#### Localization 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). + + ## License