chore: updated readme

victorgarciaesgi · Dec 23, 2024 · dad8589 · dad8589
1 parent bfe09c4
commit dad8589
Show file tree

Hide file tree

Showing 6 changed files with 103 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -39,6 +39,7 @@ It's heavily inspired by Vuelidate.
 - 📖 Model based validation
 - 🪗 Extensible
 - 🦸‍♂️ [Zod](https://zod.dev/) support
+- 🤖 [Valibot](https://valibot.dev/) support
 - 🪶 Light(~7kb gzip) and 0 dependencies
 - 🛒 Collection validation
 

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -11,4 +11,24 @@ It's heavily inspired by Vuelidate.
 
 # 📚 Documentation
 
-[![Documentation](https://raw.githubusercontent.com/victorgarciaesgi/regle/refs/heads/main/.github/images/redirectDoc.svg)](https://regle.vercel.app/) 
+[![Documentation](https://raw.githubusercontent.com/victorgarciaesgi/regle/refs/heads/main/.github/images/redirectDoc.svg)](https://regle.vercel.app/) 
+
+## 📚 Documentation
+
+[![Documentation](https://raw.githubusercontent.com/victorgarciaesgi/regle/refs/heads/main/.github/images/redirectDoc.svg)](https://regle.vercel.app/)
+
+## 🎮 Play with it
+
+| Simple demo  | Advanced Demo |
+| ------------- | ------------- |
+| [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/victorgarciaesgi/regle-examples/tree/main/examples/simple-example?file=examples/simple-example/src/App.vue&configPath=examples/simple-example)  | [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/victorgarciaesgi/regle-examples/tree/main/examples/advanced-example?file=examples/advanced-example/src/App.vue&configPath=examples/advanced-example)  |
+
+## 🧰 Features
+- ✅ Typescript first
+- 🤖 100% type inference
+- 📖 Model based validation
+- 🪗 Extensible
+- 🦸‍♂️ [Zod](https://zod.dev/) support
+- 🤖 [Valibot](https://valibot.dev/) support
+- 🪶 Light(~7kb gzip) and 0 dependencies
+- 🛒 Collection validation
diff --git a/packages/nuxt/README.md b/packages/nuxt/README.md
@@ -22,5 +22,23 @@ Install the module to your Nuxt application with one command:
 npx nuxi module add regle
 ```
 
+## 📚 Documentation
 
+[![Documentation](https://raw.githubusercontent.com/victorgarciaesgi/regle/refs/heads/main/.github/images/redirectDoc.svg)](https://regle.vercel.app/)
+
+## 🎮 Play with it
+
+| Simple demo  | Advanced Demo |
+| ------------- | ------------- |
+| [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/victorgarciaesgi/regle-examples/tree/main/examples/simple-example?file=examples/simple-example/src/App.vue&configPath=examples/simple-example)  | [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/victorgarciaesgi/regle-examples/tree/main/examples/advanced-example?file=examples/advanced-example/src/App.vue&configPath=examples/advanced-example)  |
+
+## 🧰 Features
+- ✅ Typescript first
+- 🤖 100% type inference
+- 📖 Model based validation
+- 🪗 Extensible
+- 🦸‍♂️ [Zod](https://zod.dev/) support
+- 🤖 [Valibot](https://valibot.dev/) support
+- 🪶 Light(~7kb gzip) and 0 dependencies
+- 🛒 Collection validation
 
diff --git a/packages/rules/README.md b/packages/rules/README.md
@@ -11,4 +11,24 @@ It's heavily inspired by Vuelidate.
 
 # 📚 Documentation
 
-[![Documentation](https://raw.githubusercontent.com/victorgarciaesgi/regle/refs/heads/main/.github/images/redirectDoc.svg)](https://regle.vercel.app/) 
+[![Documentation](https://raw.githubusercontent.com/victorgarciaesgi/regle/refs/heads/main/.github/images/redirectDoc.svg)](https://regle.vercel.app/) 
+
+## 📚 Documentation
+
+[![Documentation](https://raw.githubusercontent.com/victorgarciaesgi/regle/refs/heads/main/.github/images/redirectDoc.svg)](https://regle.vercel.app/)
+
+## 🎮 Play with it
+
+| Simple demo  | Advanced Demo |
+| ------------- | ------------- |
+| [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/victorgarciaesgi/regle-examples/tree/main/examples/simple-example?file=examples/simple-example/src/App.vue&configPath=examples/simple-example)  | [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/victorgarciaesgi/regle-examples/tree/main/examples/advanced-example?file=examples/advanced-example/src/App.vue&configPath=examples/advanced-example)  |
+
+## 🧰 Features
+- ✅ Typescript first
+- 🤖 100% type inference
+- 📖 Model based validation
+- 🪗 Extensible
+- 🦸‍♂️ [Zod](https://zod.dev/) support
+- 🤖 [Valibot](https://valibot.dev/) support
+- 🪶 Light(~7kb gzip) and 0 dependencies
+- 🛒 Collection validation
diff --git a/packages/valibot/README.md b/packages/valibot/README.md
@@ -11,4 +11,24 @@ It's heavily inspired by Vuelidate.
 
 # 📚 Documentation
 
-[![Documentation](https://raw.githubusercontent.com/victorgarciaesgi/regle/refs/heads/main/.github/images/redirectDoc.svg)](https://regle.vercel.app/) 
+[![Documentation](https://raw.githubusercontent.com/victorgarciaesgi/regle/refs/heads/main/.github/images/redirectDoc.svg)](https://regle.vercel.app/) 
+
+## 📚 Documentation
+
+[![Documentation](https://raw.githubusercontent.com/victorgarciaesgi/regle/refs/heads/main/.github/images/redirectDoc.svg)](https://regle.vercel.app/)
+
+## 🎮 Play with it
+
+| Simple demo  | Advanced Demo |
+| ------------- | ------------- |
+| [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/victorgarciaesgi/regle-examples/tree/main/examples/simple-example?file=examples/simple-example/src/App.vue&configPath=examples/simple-example)  | [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/victorgarciaesgi/regle-examples/tree/main/examples/advanced-example?file=examples/advanced-example/src/App.vue&configPath=examples/advanced-example)  |
+
+## 🧰 Features
+- ✅ Typescript first
+- 🤖 100% type inference
+- 📖 Model based validation
+- 🪗 Extensible
+- 🦸‍♂️ [Zod](https://zod.dev/) support
+- 🤖 [Valibot](https://valibot.dev/) support
+- 🪶 Light(~7kb gzip) and 0 dependencies
+- 🛒 Collection validation
diff --git a/packages/zod/README.md b/packages/zod/README.md
@@ -11,4 +11,24 @@ It's heavily inspired by Vuelidate.
 
 # 📚 Documentation
 
-[![Documentation](https://raw.githubusercontent.com/victorgarciaesgi/regle/refs/heads/main/.github/images/redirectDoc.svg)](https://regle.vercel.app/) 
+[![Documentation](https://raw.githubusercontent.com/victorgarciaesgi/regle/refs/heads/main/.github/images/redirectDoc.svg)](https://regle.vercel.app/) 
+
+## 📚 Documentation
+
+[![Documentation](https://raw.githubusercontent.com/victorgarciaesgi/regle/refs/heads/main/.github/images/redirectDoc.svg)](https://regle.vercel.app/)
+
+## 🎮 Play with it
+
+| Simple demo  | Advanced Demo |
+| ------------- | ------------- |
+| [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/victorgarciaesgi/regle-examples/tree/main/examples/simple-example?file=examples/simple-example/src/App.vue&configPath=examples/simple-example)  | [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/~/github.com/victorgarciaesgi/regle-examples/tree/main/examples/advanced-example?file=examples/advanced-example/src/App.vue&configPath=examples/advanced-example)  |
+
+## 🧰 Features
+- ✅ Typescript first
+- 🤖 100% type inference
+- 📖 Model based validation
+- 🪗 Extensible
+- 🦸‍♂️ [Zod](https://zod.dev/) support
+- 🤖 [Valibot](https://valibot.dev/) support
+- 🪶 Light(~7kb gzip) and 0 dependencies
+- 🛒 Collection validation