Skip to content

Update README with Zenoh library dependency instructions #475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
deanpretorius wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README with Zenoh library dependency instructions #475

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,10 @@ Zenoh is a communications protocol, therefore the permissions required are:

## <img src="jvm.png" alt="Java" height="50"> JVM

First add the Maven central repository to your `settings.gradle.kts`:
The Zenoh library can be added as both a Gradle dependency or a Maven dependency.

### Gradle
To import the library as a Gradle dependency, add the Maven central repository to your `settings.gradle.kts`:

```kotlin
dependencyResolutionManagement {
Expand All @@ -92,6 +95,27 @@ After that add to the dependencies in the app's `build.gradle.kts`:
```kotlin
implementation("org.eclipse.zenoh:zenoh-java-jvm:1.1.1")
```
### Maven Dependency

To add the library in a Maven project, add it as a dependency under the <dependencies> tag in the project's `pom.xml`:

```xml
</dependencies>
<!-- All other dependencies -->

<!-- Added Zenoh dependency -->
<dependency>
<groupId>org.eclipse.zenoh</groupId>
<artifactId>zenoh-java</artifactId>
<version>1.9.0</version>
<!-- Or the latest version available at https://mvnrepository.com/artifact/org.eclipse.zenoh/zenoh-java -->
</dependency>
</dependencies>
```
Thereafter, recompile the project with the added dependency:
```bash
mvn package
```

### Platforms

Expand Down