From bf42ad638fc44c52763b91a653f30d72047a6eca Mon Sep 17 00:00:00 2001 From: Vitor Hideyoshi Date: Mon, 23 Jun 2025 16:27:54 -0300 Subject: [PATCH] Adds Docs to README --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0cbf77e..28f1c6d 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,18 @@ Created to simplifying the process of dynamically generating Pydantic models for ## ✨ Features - ✅ Convert JSON Schema into Pydantic models dynamically; -- 🔒 Supports validation for strings, integers, floats, booleans, arrays, nested objects, allOf, anyOf and ref; +- 🔒 Supports validation for: + - strings + - integers + - floats + - booleans + - arrays + - nested objects + - allOf + - anyOf + - ref + - enum + - const - ⚙️ Enforces constraints like `minLength`, `maxLength`, `pattern`, `minimum`, `maximum`, `uniqueItems`, and more; - 📦 Zero config — just pass your schema and get a model. @@ -68,6 +79,8 @@ print(obj) ## ✅ Example Validations +Following are some examples of how to use Jambo to create Pydantic models with various JSON Schema features, but for more information, please refer to the [documentation](https://jambo.readthedocs.io/). + ### Strings with constraints ```python