formaze 1.0.7 → 1.0.8

package/README.md

@@ -204,12 +204,15 @@ You just have to add `"use client"` directive at the top of your file where you
 
 ### `createFormValidator`
 
-**argument**:
-- formSchema: `T` (A Zod schema generated through useFormSchema or directly from Zod)
+The createFormValidator function accepts an argument which is a type of zod schema and returns a Form component with built-in form validation using Zod and React Hook Form. It simplifies the creation of forms that adhere to a Zod schema for type-safe validation.
 
-The createFormValidator function returns a Form component with built-in form validation using Zod and React Hook Form. It simplifies the creation of forms that adhere to a Zod schema for type-safe validation.
+#### Argument
 
-**Returned Form Component Props**:
+**formSchema: `T`**
+
+-  Type: `T` (A Zod schema generated through useFormSchema or directly from Zod)
+
+**Props of the Returned Form Component**:
 
 **schema: `T`**
 
@@ -226,7 +229,7 @@ const schema = useFormSchema({
  password: { type: "string", minLength: { value: 8 } },
 });
 
-const Form = createFormValidator(formSchema);
+const Form = createFormValidator(schema);
 
 <Form schema={schema} onSubmit={handleSubmit} />;
 ```
@@ -303,14 +306,17 @@ The Form.Input component is a form input field that is connected to a Zod-based
 
 **Props:**
 
-- name: `keyof z.infer<T>`
-The name of the form field, which should correspond to one of the keys in the Zod schema used in the form. This connects the input to the form's validation logic.
+-  name: `keyof z.infer<T>`
+-  Description:
+   The name of the form field, which should correspond to one of the keys in the Zod schema used in the form. This connects the input to the form's validation logic.
 
-- label: `string` (optional)
-A label for the form field. This is used for displaying a descriptive text for the input field.
+-  label: `string` (optional)
+-  Description:
+   A label for the form field. This is used for displaying a descriptive text for the input field.
 
-- ...props: `React.HTMLAttributes<HTMLInputElement>`
-Any additional props that can be passed to an HTML input element. These props allow you to customize the input field, such as adding a placeholder, className, type, etc.
+-  ...props: `React.HTMLAttributes<HTMLInputElement>`
+-  Description:
+   Any additional props that can be passed to an HTML input element. These props allow you to customize the input field, such as adding a placeholder, className, type, etc.
 
 ### `useFormSchema`
 
@@ -344,7 +350,7 @@ This schema can then be passed to the Form component returned by `createFormVali
 
 ## Changes
 
-The `createFormValidator` has been changed to accept an arugument which is type of zod schema generated through useFormSchema or Zod and the rest of the logic will be the same as before.
+The `createFormValidator` has been changed to accept an argument which is a type of zod schema generated through useFormSchema or directly from Zod and the rest of the logic will be the same as before.
 
 In order to give proper type support for JavaScript project and to simplify the defining process this change has been made.
 

package/package.json

@@ -3,7 +3,7 @@
 	"description": "An easy form validation package for react, built by using React hook form and zod library",
 	"main": "dist/formaze.js",
 	"types": "dist/index.d.ts",
-	"version": "1.0.7",
+	"version": "1.0.8",
 	"type": "module",
 	"keywords": [
 		"react",