Skip to content

Commit c0d8aad

Browse files
authored
docs: Clarify optionality of frameworks in README (#576)
* Readme update * fix unintended formatting changes
1 parent 8d21bfa commit c0d8aad

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,26 @@ The SDK simplifies the setup and interaction with SAP AI Core, allowing you to f
3030

3131
## General Requirements
3232

33-
To use the SDK in a Java application, it is necessary to understand the technical prerequisites and required versions for common dependencies.
33+
#### Development Environment
3434

35-
- Java 17 or higher.
36-
- Access to an **SAP AI Core Service** instance.
35+
These are required on the developer side to build and run applications with the SDK:
3736

38-
Please refer to [this documentation on **how to connect the SDK to AI Core**](https://sap.github.io/ai-sdk/docs/java/guides/connecting-to-ai-core).
37+
* **Java JDK**: 17 or higher (21 LTS recommended).
38+
* **SAP Cloud SDK**: 5.6.0 or later (latest recommended, added as a Maven dependency).
3939

40-
The following table lists the required versions, based on the latest release:
40+
#### SAP AI Core Service instance
4141

42-
| Dependency | Minimum Version | Recommended Version |
43-
|------------------------|-----------------|---------------------|
44-
| JDK | 17 (LTS) | 21 (LTS) |
45-
| SAP Cloud SDK | 5.6.0 | latest |
46-
| (optional) CAP Java | 3.0.0 | latest |
47-
| (optional) Spring Boot | 3.0 | latest |
48-
| (optional) Spring AI | 1.0.0 | latest |
42+
To make of use the services supported by the SDK, you need to have access to an SAP AI Core Service instance. Checkout [how to connect](link).
4943

50-
See [an example `pom.xml` in our Spring Boot application](sample-code/spring-app/pom.xml).
44+
#### Optional Integrations
45+
46+
The SDK can be combined with popular Java frameworks. These are not required for core functionality, but version compatibility is listed for reference:
47+
48+
* **Spring AI** ≥ 1.0.0
49+
* **Spring Boot** ≥ 3.0
50+
* **CAP Java** ≥ 3.0.0
51+
52+
👉 See an [example `pom.xml`](link) in our sample Spring Boot application.
5153

5254
> [!WARNING]
5355
> All classes under any of the `...model` packages are generated from an OpenAPI specification and marked as `@Beta`.

0 commit comments

Comments
 (0)