Skip to content

Conversation

@timsneath
Copy link
Collaborator

Added some extra explanatory text for the main "recommended" example.

When you press the "Hash" button in the app, it calls directly from Kotlin into
Swift code to compute a SHA256 hash—no manual JNI code required. The swift-java
tooling handles all the bridging automatically, making it easy to expose Swift
APIs to your Android application with type safety and minimal boilerplate.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about explaining the example in this README, just because we go in depth in each example's own README;

I'd keep the main README pretty slim so we don't have to come back to it when working "in" a specific example and updating its own docs.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do agree in general, but for this specific first example, I think it might be helpful to be a little more explicit. At least for myself, I read the main README and then cloned the project. I didn't even discover that there were per-project READMEs at first -- I just opened the most likely looking one in Android Studio.

demonstrates how to build a Swift library that can be seamlessly called from
Kotlin/Java code using [swift-java](https://github.com/swiftlang/swift-java),
which automatically generates the necessary Java wrappers and JNI bindings for
you.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be good addition

@finagolfin
Copy link
Member

Added some fixes, feel free to submit more revisions.

@finagolfin finagolfin merged commit 3b70d8f into swiftlang:rec Nov 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants