From 3e49606ebc820fc8235d81d4b592118a960a6451 Mon Sep 17 00:00:00 2001 From: Ivan Yonkov Date: Mon, 1 Jan 2024 11:41:10 +0200 Subject: [PATCH] #13: Added a table with supported java versions --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6c4cc01..67337f9 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ ## Preambule -This library provides a Software Development Kit (SDK) for Java 21+ compliant runtimes +This library provides a Software Development Kit (SDK) for Java 21([see others](#supported-java-versions)) compliant runtimes to connect to an OpenAI API and execute both synchronous and asynchronous (via callbacks or the Reactor Pattern) calls. @@ -33,6 +33,7 @@ Of course, due to its native SDK, objects of any kind are easily created. ## Table of Contents * [Quick Start](#quick-start) +* [Supported Java Version](#supported-java-versions) * [Available SDKs](#available-sdks) * [List](#list) * [Simple Usage Similarity](#simple-usage-similarity) @@ -261,6 +262,20 @@ Java, you make every byte worthwhile. +## Supported Java Versions + +The `master` branch builds versions for JDK 21. This is the current Java version and the artifacts built from +`master` does not contain any JDK suffix. However, there are several other branches which build versions +for different JDKs. See the table below: + +| Branch | Target JDK | Artifact Version Pattern | +|------------------------------------------------------------------------------------|------------|-----------------------------------------| +| [master](https://github.com/CodexioLtd/openai-api-sdk/tree/master) | 21 | X.Y.Z[.a] (e.g. 0.8.0.BETA) | +| [release/jdk-17](https://github.com/CodexioLtd/openai-api-sdk/tree/release/jdk-17) | 17 | X.Y.Z[.a]-JDK17 (e.g. 0.8.0.BETA-JDK17) | +| [release/jdk-11](https://github.com/CodexioLtd/openai-api-sdk/tree/release/jdk-11) | 11 | X.Y.Z[.a]-JDK11 (e.g. 0.8.0.BETA-JDK11) | +| [release/jdk-8](https://github.com/CodexioLtd/openai-api-sdk/tree/release/jdk-8) | 8 | X.Y.Z[.a]-JDK8 (e.g. 0.8.0.BETA-JDK8) | + + ## Available SDKs ### List