search

eclipse-vertx / vertx-json-schema

Vert.x Json Schema
Other
78 stars 32 forks source link

Needs better documentation on how to use #47

Closed asad-awadia closed 3 years ago

asad-awadia commented 3 years ago

The current readme is insufficient on providing enough context on how to use this lib

Needs more documentation and examples

tsegismont commented 3 years ago

The documentation is available online https://vertx.io/docs/vertx-json-schema/java/

I will update the README file to make it look like those of the other Vert.x projects.

asad-awadia commented 3 years ago

@tsegismont that documentation isn't helpful either

needs better examples/guides

tsegismont commented 3 years ago

@slinkydeveloper have you planned to write an how-to?

@asad-awadia you need to be more specific about what information you're missing. In the meantime, perhaps you can have a look at test code?