From 79b25f15e341ccdfe15028185d0e22d519d8d788 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=96zg=C3=BCr=20Adem=20I=C5=9EIKLI?=
 <i.ozguradem@gmail.com>
Date: Sat, 23 Dec 2023 16:11:41 +0100
Subject: [PATCH] Added options doc

---
 docs/.vitepress/config.mts |  1 +
 docs/options.md            | 41 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+)
 create mode 100644 docs/options.md

diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
index 88383a6..009597c 100644
--- a/docs/.vitepress/config.mts
+++ b/docs/.vitepress/config.mts
@@ -37,6 +37,7 @@ export default defineConfig({
         items: [
           { text: "Rules", link: "/rules" },
           { text: "i18n", link: "/i18n" },
+          { text: "Options", link: "/options" },
         ],
       },
     ],
diff --git a/docs/options.md b/docs/options.md
new file mode 100644
index 0000000..87b5ff5
--- /dev/null
+++ b/docs/options.md
@@ -0,0 +1,41 @@
+# Options
+
+## Default options
+
+You can set options for the validator.
+
+```ts
+import { validate, setLocales, setOptions } from "robust-validator";
+import en from "robust-validator/dist/i18n/en.json";
+
+setLocales(en);
+
+// Setting the default options
+setOptions({
+  stopOnFail: true,
+  language: "en",
+});
+```
+
+## Active options
+
+You can override the default options for a validate action like the following example:
+
+```ts
+import { validate, setLocales, setOptions } from "robust-validator";
+import en from "robust-validator/dist/i18n/en.json";
+
+setLocales(en);
+
+// Setting the default options
+setOptions({
+  stopOnFail: true,
+  language: "en",
+});
+
+await validate(
+  data,
+  { email: "required" },
+  { stopOnFail: false, language: "de" }, // Override
+);
+```