Adds Docs to README

This commit is contained in:
2025-06-23 16:27:54 -03:00
parent 1bb0995d79
commit bf42ad638f

View File

@@ -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