⁑ Align names and cleanup README

Author: Daniel Requejo

README.md

@@ -6,8 +6,8 @@ The easy way of handling your vue forms
 </div>
 
 [![Build Status](https://github.com/mattphillips/deep-object-diff/actions/workflows/ci.yaml/badge.svg)](https://github.com/dbssman/vue-form-handler/actions/workflows/node.js.yml)
-[![version](https://img.shields.io/npm/v/deep-object-diff.svg?style=flat-square)](https://www.npmjs.com/package/deep-object-diff)
-[![downloads](https://img.shields.io/npm/dm/deep-object-diff.svg?style=flat-square)](http://npm-stat.com/charts.html?package=deep-object-diff&from=2016-11-23)
+[![version](https://img.shields.io/npm/v/deep-object-diff.svg?style=flat-square)](https://www.npmjs.com/package/vue-form-handler)
+[![downloads](https://img.shields.io/npm/dm/deep-object-diff.svg?style=flat-square)](http://npm-stat.com/charts.html?package=vue-form-handler&from=2023-01-20)
 [![MIT License](https://img.shields.io/npm/l/deep-object-diff.svg?style=flat-square)](https://github.com/dbssman/vue-form-handler/blob/master/License.md)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 

docs/tutorial.md

@@ -193,7 +193,7 @@ We can also pass a validation function and specify `validationMode: 'onSubmit'`
     <input type="password" v-bind="register('confirmPassword', {
       required: true,
       pattern: passwordRegExp,
-      validations: {
+      validate: {
         match: (value) => value === values.password || 'Passwords do not match'
       }
     })" />
@@ -244,7 +244,7 @@ If the submission fails it will call the error function we pass with the errors
     <input type="password" v-bind="register('confirmPassword', {
       required: true,
       pattern: passwordRegExp,
-      validations: {
+      validate: {
         match: (value) => value === values.password || 'Passwords do not match'
       }
     })" />

src/test/register.test.ts

@@ -48,7 +48,7 @@ describe('Register function testing', () => {
     it('Registered validations work on update via handler', async () => {
         const { values, register, formState } = useFormHandler();
         const field = register('field', {
-            validations: {
+            validate: {
                 error: (val) => val !== 'error' || 'Error with your field'
             }
         })
@@ -61,7 +61,7 @@ describe('Register function testing', () => {
     it('Registered validations work on update via setter', async () => {
         const { values, register, formState, setValue, triggerValidation } = useFormHandler();
         register('field', {
-            validations: {
+            validate: {
                 error: (val) => val !== 'error' || 'Error with your field'
             }
         })

src/types/register.ts

@@ -18,8 +18,8 @@ export interface RegisterOptions extends ValidationsConfiguration {
     /** Default value for the field */
     defaultValue?: any
 
-    /** Validations for the field */
-    validations?: Validations
+    /** Custom validations for the field */
+    validate?: Validations
 
     /** Set to true if you want to bind also dirty and touched states */
     withDetails?: boolean

src/useFormHandler.ts

@@ -54,7 +54,7 @@ const useFormHandler: FormHandler = ({
       _validations: {
         ...(!options.useNativeValidation
           && transformValidations(options as ValidationsConfiguration)),
-        ...(options.validations || {})
+        ...(options.validate || {})
       },
       _defaultValue: options.defaultValue,
       _disabled: !!options.disabled,
@@ -218,7 +218,7 @@ const useFormHandler: FormHandler = ({
 
   const register: Register = (name, options = {}) => {
     const {
-      validations,
+      validate,
       defaultValue,
       disabled,
       withDetails,