Enhancement: Update documentation to better explain how to use library in maven project #280
Description
Is there an existing issue for this?
- I have searched the existing issues
Enhancement description
Yesterday, my colleagues and I tried to use your library and couldn't figure a way to import any of the classes in your readme exemple.
After talking about it to other teams, one of the devs finally tells me that i had to import a specific "sub"library because the main one is basically an empty shell when it's imported.
So, delcaring in a pom.xml with Maven :
<dependency> <groupId>io.github.optimumcode</groupId> <artifactId>json-schema-validator</artifactId> <version>0.5.0</version> </dependency>
Would result in an error when trying to import your library, whereas :
<dependency> <groupId>io.github.optimumcode</groupId> <artifactId>json-schema-validator-jvm</artifactId> <version>0.5.0</version> </dependency>
Would work.
As I did not seemd to find any other issue in this github page about this, we must be a bit dumb but still, there's probably other people like us I guess ?
In my opinion the readme is a bit misleading here and it took quite a lot of trial and error to understand what the problem could've been.