From d3e428da52ab00ce7e4497a1743afe27386340a3 Mon Sep 17 00:00:00 2001 From: Darius Maitia Date: Mon, 25 Sep 2023 13:14:15 +0200 Subject: [PATCH] Updating README.md to point to the documentation, as well as adding instructions on how to build the doc. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 8c9e6fb7..a500a921 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ [![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/) @@ -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 @@ -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