diff --git a/README.md b/README.md index 9bdb7e5330add876fd370eb0940a444e8fbebaa7..da440b6ee11a4ec3134b43126164abda6f68b3de 100644 --- a/README.md +++ b/README.md @@ -1 +1,22 @@ -## FitCo Java SDK \ No newline at end of file +## FIT-Co Java SDK + + +### Build + +To build the maven artifact, run: `mvn clean install` +#### +To run all tests, run: `mvn test` + +### Modules +#### API Module +The api module consists of all domain model classes and (api-) public interfaces needed to build an sdk-client + +#### Client Module +API implementations and Tests + +### Documentation +https://docs.fitko.de/fit-connect/docs/ + +### Self Service Portal (DEV) +https://portal.auth-testing.fit-connect.fitko.dev/ +