Skip to content

Commit

Permalink
docs(bindings/java): update the README file (#2338)
Browse files Browse the repository at this point in the history
Signed-off-by: tison <[email protected]>
  • Loading branch information
tisonkun authored May 27, 2023
1 parent c1305cc commit 8797a24
Showing 1 changed file with 31 additions and 24 deletions.
55 changes: 31 additions & 24 deletions bindings/java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,37 @@
You can use the package by adding the dependency as following:

```xml
<dependencies>
<dependency>
<groupId>org.apache.opendal</groupId>
<artifactId>opendal-java</artifactId>
<version>0.1.0-SNAPSHOT</version>
<classifier>${os.detected.classifier}</classifier>
</dependency>
</dependencies>

<build>
<extensions>
<extension>
<groupId>kr.motd.maven</groupId>
<artifactId>os-maven-plugin</artifactId>
<version>1.7.0</version>
</extension>
</extensions>
</build>
<project>
<repositories>
<repository>
<id>apache.snapshots</id>
<name>Apache Snapshot Repository</name>
<url>https://repository.apache.org/snapshots</url>
<releases>
<enabled>true</enabled>
</releases>
</repository>
</repositories>

<dependencies>
<dependency>
<groupId>org.apache.opendal</groupId>
<artifactId>opendal-java</artifactId>
<version>0.1.0-SNAPSHOT</version>
<classifier>${os.detected.classifier}</classifier>
</dependency>
</dependencies>

<build>
<extensions>
<extension>
<groupId>kr.motd.maven</groupId>
<artifactId>os-maven-plugin</artifactId>
<version>1.7.0</version>
</extension>
</extensions>
</build>
</project>
```

## Build
Expand All @@ -44,9 +57,3 @@ You can run tests with the following command:
```shell
mvn clean verify
```

## Todos

- [ ] ReadMe for usage
- [ ] Development/Contribution guide.
- [ ] Cross-platform build for release build.

0 comments on commit 8797a24

Please sign in to comment.