Adds Docs to README
This commit is contained in:
15
README.md
15
README.md
@@ -28,7 +28,18 @@ Created to simplifying the process of dynamically generating Pydantic models for
|
|||||||
## ✨ Features
|
## ✨ Features
|
||||||
|
|
||||||
- ✅ Convert JSON Schema into Pydantic models dynamically;
|
- ✅ 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;
|
- ⚙️ Enforces constraints like `minLength`, `maxLength`, `pattern`, `minimum`, `maximum`, `uniqueItems`, and more;
|
||||||
- 📦 Zero config — just pass your schema and get a model.
|
- 📦 Zero config — just pass your schema and get a model.
|
||||||
|
|
||||||
@@ -68,6 +79,8 @@ print(obj)
|
|||||||
|
|
||||||
## ✅ Example Validations
|
## ✅ 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
|
### Strings with constraints
|
||||||
|
|
||||||
```python
|
```python
|
||||||
|
|||||||
Reference in New Issue
Block a user