Need a better getting started example.

rmpestano / cukedoctor

BDD living documentation using Cucumber and Asciidoctor: https://goo.gl/Yp3NiU

https://rmpestano.github.io/cukedoctor/

Apache License 2.0

123 stars 23 forks source link

Need a better getting started example. #232

Open Johnlon opened 2 years ago

Johnlon commented 2 years ago

Needs to be a

a complete isolated module
single basic feature file
working glue code

Then... Explain the additional work needed to add cukedocktor to get the reports.

rmpestano commented 2 years ago

Hi @Johnlon, on the readme you can find examples on how to use the library. You can use it as a library (e.g depend on cukedoctor-converter), as a maven plugin or a java standalone (cli).