Skip to content

Commit e072b2e

Browse files
authored
Revise project status and API stability notes in README
Updated README to clarify project status and API stability.
1 parent cfbcf6c commit e072b2e

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,9 @@ This repository contains two approaches to Swift/Java interoperability.
77

88
## :construction: Early Development :construction:
99

10-
**:construction: This is a *very early* prototype and everything is subject to change. :construction:**
10+
**:construction: This project is in early development, please keep this in mind as you try out the project and do provide feedback about any issues you encounter. :construction:**
1111

12-
Parts of this project are incomplete, not fleshed out, and subject to change without any notice.
13-
14-
The primary purpose of this repository is to create an environment for collaboration and joint exploration of the Swift/Java interoperability story. The project will transition to a more structured approach once key goals have been outlined.
12+
There is no guarantee about API stability of this package, neither in the Java or Swift parts, until the project releases a stable 1.0 release; APIs may change without prior notice.
1513

1614
### :construction: Self-publish support Java libraries (SwiftKit)
1715

@@ -66,7 +64,7 @@ SwiftJava is a Swift library offering macros which simplify writing JNI code "by
6664
It is possible to generate Swift bindings to Java libraries using SwiftJava by using the `swift-java wrap-java` command.
6765

6866
Required language/runtime versions:
69-
- **JDK 17+**, any recent JDK installation should be sufficient, as only general reflection and JNI APIs are used by this integration
67+
- **JDK 17+**, any recent JDK installation should be sufficient, as only general reflection and JNI APIs are used by this integratio
7068
- **Swift 6.0.x**, because the library uses modern Swift macros
7169

7270
**swift-java jextract**
@@ -83,8 +81,7 @@ This is the primary way we envision calling Swift code from server-side Java lib
8381

8482
Required language/runtime versions:
8583
- **Swift 6.1**, because of dependence on rich swift interface files
86-
- **JDK 24+**
87-
- We are validating the implementation using the currently supported non-LTE release, which at present means JDK-24.
84+
- **JDK 25+**, the most recent LTS release which includes the stable Foreign Function and Memory APIs.
8885

8986
## swift-java jextract --mode=jni
9087

0 commit comments

Comments
 (0)