From 120748f508e2ba362baee2c781636cb88d621bb1 Mon Sep 17 00:00:00 2001
From: Nicco <nicco.borgioli@gmail.com>
Date: Thu, 26 Sep 2019 22:53:43 +0200
Subject: [PATCH] Update README.md

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/README.md b/README.md
index 9e34031..8f80595 100644
--- a/README.md
+++ b/README.md
@@ -84,3 +84,50 @@ const Form = () => {
 ```typescript
 const {auto, errors, update, form} = useForm(initial, validators, options)
 ```
+
+### Initial
+
+This is the base state of the form. Also the typescript types are inhered by this.
+
+###### Example
+
+```javascript
+const initial = {
+  username: 'defaultValue',
+  password: '',
+  rememberMe: true,
+}
+```
+
+### Validators
+
+A validator is an object that taked in either a `RegExp` or a `Function` (can be async). Optionally you can pass a message string that will be displayed instead of the default one.
+
+###### Example: Regular Expression
+
+```javascript
+const validators = {
+  // Only contains letters. 
+  // This could also be a (also async) function that returns a boolean.
+  username: /^[A-z]*$/,
+}
+```
+
+###### Example: Function
+
+```typescript
+const validators = {
+  username: (value: string) => value.lenght > 3,
+}
+```
+
+###### Example: With Object
+
+```javascript
+const validators = {
+  username: {
+    validator: /^[A-z]*$/,
+    message: 'My custom error message',
+  }
+}
+```