Skip to content

Commit

Permalink
#13: Added a table with supported java versions
Browse files Browse the repository at this point in the history
  • Loading branch information
ivanyonkov committed Jan 1, 2024
1 parent 47be431 commit 3e49606
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<sup>([see others](#supported-java-versions))</sup> compliant runtimes
to connect to an OpenAI API and execute both synchronous and asynchronous (via callbacks
or the Reactor Pattern) calls.

Expand All @@ -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)
Expand Down Expand Up @@ -261,6 +262,20 @@ Java, you make every byte worthwhile.

</details>

## 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
Expand Down

0 comments on commit 3e49606

Please sign in to comment.