Skip to content

Commit 445ca61

Browse files
committed
Update readme
1 parent 05f3fab commit 445ca61

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ schemas.
4343

4444
### Using the validation results
4545

46-
The validation methods above will return an instance of `ValidationResult`.
46+
The validation methods above will return the `ValidationResult` record. This will contain a summary of the
47+
validation process, as well as a map of validation results per file. See javadocs in `model` for details.
4748

48-
TODO: add more documentation here - consider turning ValidationResult and friends into interfaces or records...?
4949

5050
## Additional validation rules
5151

0 commit comments

Comments
 (0)