Skip to content

Commit

Permalink
docs(bindings/java): Added an example of adding dependencies using Gr…
Browse files Browse the repository at this point in the history
…adle (#3158)

Co-authored-by: tison <[email protected]>
  • Loading branch information
eastack and tisonkun authored Sep 22, 2023
1 parent 5791b6b commit 2d6c4c8
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions bindings/java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

This project is built upon the native OpenDAL lib. And it is released for multiple platforms that you can use a classifier to specify the platform you are building the application on.

### Maven

Generally, you can first add the `os-maven-plugin` for automatically detect the classifier based on your platform:

```xml
Expand Down Expand Up @@ -39,6 +41,30 @@ Then add the dependency to `opendal-java` as following:
</dependency>
```

### Gradle

For Gradle you can first add the `com.google.osdetector` for automatically detect the classifier based on your platform:

```groovy
plugins {
...
id "com.google.osdetector" version "1.7.3"
}
```

Then add the dependency to `opendal-java` as following:

```groovy
dependencies {
...
// OpenDAL
implementation "org.apache.opendal:opendal-java:0.40.0"
implementation "org.apache.opendal:opendal-java:0.40.0:$osdetector.classifier"
}
```

### Classified library
Note that the dependency without classifier ships all classes and resources except the "opendal_java" shared library. And those with classifier bundle only the shared library.

For downstream usage, it's recommended:
Expand Down

0 comments on commit 2d6c4c8

Please sign in to comment.