Skip to content

Commit

Permalink
[doc] small improvement on doc
Browse files Browse the repository at this point in the history
  • Loading branch information
CXwudi committed Aug 1, 2022
1 parent 8b83b3f commit 98b4ac9
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@ TODO: finish this part when published with JitPack

## How to use

Call [`EasyCucumber.build()`](src\main\java\scs\comp5903\cucumber\EasyCucumber.java) method to parse and create a cucumber test,
it will return an executable instance of [`JFeature`](src/main/java/scs/comp5903/cucumber/execution/JFeature.java) that can run the cucumber test through calling `JFeature.execute()`.
Call [`EasyCucumber.build()`](src/main/java/scs/comp5903/cucumber/EasyCucumber.java) method to parse and create a
cucumber test,
it will return an executable instance of [`JFeature`](src/main/java/scs/comp5903/cucumber/execution/JFeature.java) that
can run the cucumber test through calling `JFeature.execute()`.

Currently, this project is still WIP (work in progress), but at least it is in a usable stage.

Expand All @@ -38,6 +40,9 @@ Currently, this project is still WIP (work in progress), but at least it is in a

## Extra Features that Official Cucumber does not support

- Several `EasyCucumber.build()` methods can take the instance of your step definition class as parameter. In this case, the cucumber will use your instance to run the step, instead of create a fresh new instance of the step definition class using Java Reflection API
- This can be useful for sharing states between different cucumber tests
- Several `EasyCucumber.build()` methods can take the instance of your step definition class as parameter. In this case,
the cucumber will use your instance to run the step, instead of create a fresh new instance of the step definition
class using Java Reflection API
- This can be useful for sharing states between different cucumber tests,
or sharing the same step definition class instance across multiple cucumber tests
- TODO: more to come

0 comments on commit 98b4ac9

Please sign in to comment.