Skip to content

Commit 12d5412

Browse files
committed
add intro to SwiftJavaDocumentation index.md
1 parent 0ca4e7e commit 12d5412

File tree

1 file changed

+15
-1
lines changed
  • Sources/SwiftJavaDocumentation/Documentation.docc

1 file changed

+15
-1
lines changed

Sources/SwiftJavaDocumentation/Documentation.docc/index.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,21 @@ Please refer to articles about the specific direction of interoperability you ar
1111

1212
### Getting started
1313

14-
TODO: Some general intro
14+
**SwiftJava** provides Java and Swift interoperability with minimal overhead. It eliminates the complex, error-prone process of manually compiling Java classes to C headers for native access. With SwiftJava, developers can achieve a flexible, safe, and high-performance connection between the two languages.
15+
16+
#### Interoperability promotes
17+
- Incremental adoption of Swift
18+
- Reuse of libraries
19+
- Support for ecosystem-specific build tools
20+
21+
#### Tools
22+
- Swift Package:
23+
- JavaKit (Java -> Swift)
24+
- Java Library:
25+
- SwiftKit (Swift -> Java)
26+
- Tooling:
27+
- swift-java: command line tool [SwiftJavaCommandLineTool](#SwiftJavaCommandLineTool)
28+
- Build tool integration: SwiftPM Plugin or Gradle [SwiftPMPlugin](#SwiftPMPlugin)
1529

1630
If you prefer a video introduction, you may want to watch this
1731
[Explore Swift and Java interoperability](https://www.youtube.com/watch?v=QSHO-GUGidA)

0 commit comments

Comments
 (0)