Skip to content

Commit

Permalink
example: update README.md with links to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
prohde committed Sep 21, 2023
1 parent a7bc539 commit 6999dcf
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

The example data was generated using the LUBM data generator to create data for one university.
In order to provide a good example, i.e., containing only a few entities, only a subset of the generated data is included.
The data can be found in the directory `data/raw`.
Additionally, we provide some example SHACL shapes for validating the data.
The shapes are located in the directory `shapes/LUBM`.

Start the SPARQL endpoint and Trav-SHACL Docker container with
```bash
Expand All @@ -14,9 +16,10 @@ docker-compose up -d --build
> Usually, it should be fast.
> You can check if the data is loaded by trying to access `http://localhost:9090/sparql`.
In order to validate the shape schema over the knowledge graph, run
```bash
./validate.sh
```
## Trav-SHACL as a Library

If you want to use Trav-SHACL as a library, check out the description of how to run the example at https://sdm-tib.github.io/Trav-SHACL/library.html#example.

## Trav-SHACL as a Service

If you want to try different parameters, please check the README of the main directory of the repository for a detailed description of all possibilities.
If you are interested in running Trav-SHACL as a service, check out the description of how to use it with this example at https://sdm-tib.github.io/Trav-SHACL/service.html#example.

0 comments on commit 6999dcf

Please sign in to comment.