Skip to content

Commit

Permalink
Updating README.md to point to the documentation, as well as adding i…
Browse files Browse the repository at this point in the history
…nstructions on how to build the doc.
  • Loading branch information
DariusIMP committed Sep 25, 2023
1 parent 549d37a commit d3e428d
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<img src="https://raw.githubusercontent.com/eclipse-zenoh/zenoh/master/zenoh-dragon.png" height="150">

[![CI](https://github.com/eclipse-zenoh/zenoh-kotlin/workflows/CI/badge.svg)](https://github.com/eclipse-zenoh/zenoh-kotlin/actions?query=workflow%3A%22CI%22)
[![Release status](https://github.com/eclipse-zenoh/zenoh-kotlin/actions/workflows/release.yml/badge.svg)](https://github.com/eclipse-zenoh/zenoh-kotlin/actions/workflows/release.yml)
[![Discussion](https://img.shields.io/badge/discussion-on%20github-blue)](https://github.com/eclipse-zenoh/roadmap/discussions)
[![Discord](https://img.shields.io/badge/chat-on%20discord-blue)](https://discord.gg/2GJ958VuHs)
[![License](https://img.shields.io/badge/License-EPL%202.0-blue)](https://choosealicense.com/licenses/epl-2.0/)
Expand All @@ -24,6 +25,12 @@ This repository provides a Kotlin binding based on the main [Zenoh implementatio

The code relies on native code written in Rust and communicates with it via the Java Native Interface (JNI).

## Documentation

The documentation of the API is published at https://eclipse-zenoh.github.io/zenoh-kotlin/index.html.

Alternatively, you can build it locally as [explained below](#building-the-documentation).

----

# How to build it
Expand Down Expand Up @@ -88,6 +95,16 @@ Then you can build by simply:

That was it! We now can build our first Kotlin app using Zenoh!

### Building the documentation

Because it's a Kotlin project, we use [Dokka](https://kotlinlang.org/docs/dokka-introduction.html) to generate the documentation.

In order to build it, run:
```bash
gradle zenoh-kotlin:dokkaHtml
```


---

# Examples
Expand Down

0 comments on commit d3e428d

Please sign in to comment.