diff --git a/README.md b/README.md index da440b6ee11a4ec3134b43126164abda6f68b3de..bef4b1a99098c2df5d46600873fef6673e0400bc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ ## FIT-Co Java SDK - +### Project Setup Info +- Java 17 (LTS) +- Maven +- Junit 5 ### Build To build the maven artifact, run: `mvn clean install` @@ -8,6 +11,7 @@ To build the maven artifact, run: `mvn clean install` To run all tests, run: `mvn test` ### Modules +The SDk is set up as a maven multi module to separate the (internal) API properly from implementation details #### API Module The api module consists of all domain model classes and (api-) public interfaces needed to build an sdk-client