diff --git a/README.md b/README.md index a099036..b358975 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ -TBD +# Lyo Validation library + +The library is intended to check whether resource instances conform to SHACL shapes. + +## Getting started + +Add the following repository to your POM file: + +```xml + + + lyo-releases + Eclipse Lyo Releases + https://repo.eclipse.org/content/repositories/lyo-releases/ + + false + + + +``` + +Now add a dependency for the library: + +```xml + + org.eclipse.lyo + lyo-validation + 2.3.0.M3 + +``` + +Start by reading up on [`Validator`](http://download.eclipse.org/lyo/docs/validation/2.3.0.M3/org/eclipse/lyo/validation/Validator.html) Javadoc.