From 72a518a0f55db025de94877e1ca2c132337ee8a7 Mon Sep 17 00:00:00 2001 From: tison Date: Sun, 28 May 2023 22:05:08 +0800 Subject: [PATCH] chore(bindings/java): post release 0.1.0 (#2352) Signed-off-by: tison --- bindings/java/README.md | 80 +++++++++++++++++++++++++---------------- bindings/java/pom.xml | 5 +-- 2 files changed, 52 insertions(+), 33 deletions(-) diff --git a/bindings/java/README.md b/bindings/java/README.md index 204875350e2f..59a527922043 100644 --- a/bindings/java/README.md +++ b/bindings/java/README.md @@ -1,41 +1,59 @@ # OpenDAL Java Bindings -## Usage +[![Maven Central](https://img.shields.io/maven-central/v/org.apache.opendal/opendal-java.svg?logo=Apache+Maven&logoColor=blue)](https://central.sonatype.com/search?q=opendal-java&smo=true) +[![Website](https://img.shields.io/badge/opendal-OpenDAL_Website-red?logo=Apache&logoColor=red)](https://opendal.apache.org/docs/java/) -You can use the package by adding the dependency as following: + +## Getting Started + +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. + +Generally, you can first add the `os-maven-plugin` for automatically detect the classifier based on your platform: + +```xml + + + + kr.motd.maven + os-maven-plugin + 1.7.0 + + + +``` + +Then add the dependency to `opendal-java` as following: ```xml - - + + org.apache.opendal + opendal-java + ${opendal.version} + ${os.detected.classifier} + +``` + +If you'd rather like the latest snapshots of the upcoming major version, use ASF Maven snapshot repository: + +```xml + - apache.snapshots - Apache Snapshot Repository - https://repository.apache.org/snapshots - - true - + apache.snapshots + Apache Snapshot Repository + https://repository.apache.org/snapshots - - - - - org.apache.opendal - opendal-java - 0.1.0-SNAPSHOT - ${os.detected.classifier} - - - - - - - kr.motd.maven - os-maven-plugin - 1.7.0 - - - - + +``` + +... and declare the appropriate dependency version: + +```xml + + org.apache.opendal + opendal-java + ${opendal.snapshot-version} + ${os.detected.classifier} + ``` ## Build diff --git a/bindings/java/pom.xml b/bindings/java/pom.xml index 69cb5c226216..2bac6b2632d6 100644 --- a/bindings/java/pom.xml +++ b/bindings/java/pom.xml @@ -32,7 +32,7 @@ org.apache.opendal opendal-java - 0.1.0-SNAPSHOT + 0.2.0-SNAPSHOT https://opendal.apache.org @@ -61,6 +61,7 @@ 3.0.0 3.1.0 + 1.7.0 2.37.0 @@ -151,7 +152,7 @@ kr.motd.maven os-maven-plugin - 1.7.0 + ${os-maven-plugin.version}