Skip to content

Update README to push swift-java as the recommended approach #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README to push swift-java as the recommended approach #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
# Swift Android Examples

This repository contains example applications that demonstrate how to use the [Swift SDK for Android](https://swift.org/install). Each example showcases different integration patterns for Swift on Android.
This repository contains example applications that demonstrate how to use the
[Swift SDK for Android](https://swift.org/install). Each example showcases different
integration patterns for Swift on Android. It is highly recommended that you use
the automated swift-java interop that generates bindings for you; the others are
merely provided as examples for those who want to dig deeper and see the raw JNI,
or not use Java at all.

## Available Examples

Examples using [swift-java](https://github.com/swiftlang/swift-java) to generate necessary Swift/Java bridging:
- **[hello-swift-java](hello-swift-java/)** - application that demonstrates how to call Swift code from an Android app with automatically generated Java wrappers and JNI code using [swift-java](https://github.com/swiftlang/swift-java).
Examples using [swift-java](https://github.com/swiftlang/swift-java) to generate
the necessary Swift/Java bridging:
- **[hello-swift-java](hello-swift-java/)** - application that demonstrates how
to call Swift code from an Android app with automatically generated Java wrappers
and JNI code.

An example of a purely native Swift app, which calls no Java APIs:
- **[native-activity](native-activity/)** - complete native Android activity with
OpenGL ES rendering written entirely in Swift.

Examples using raw JNI, without generated bridging sources:
- **[hello-swift-raw-jni](hello-swift-raw-jni/)** - basic Swift integration that calls a Swift function.
- **[hello-swift-raw-jni-callback](hello-swift-raw-jni-callback/)** - demonstrates bidirectional communication with Swift timer callbacks updating Android UI.
- **[hello-swift-raw-jni-library](hello-swift-raw-jni-library/)** - shows how to package Swift code as a reusable Android library component.
- **[native-activity](native-activity/)** - complete native Android activity with OpenGL ES rendering written entirely in Swift.