Skip to content

Commit

Permalink
Merge pull request #144 from ZettaScaleLabs/readme-update
Browse files Browse the repository at this point in the history
Readme update after 1.0.0-beta.1 release.
  • Loading branch information
milyin authored Sep 3, 2024
2 parents 0e968a9 + 5a41bd2 commit f9b78d0
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,16 @@ Alternatively, you can build it locally as [explained below](#building-the-docum

:warning: Note nº1: **Breaking changes incoming**

We are currently releasing a series of alpha versions, the latests one being currently the
[1.0.0-alpha.6](https://github.com/eclipse-zenoh/zenoh-java/releases/tag/1.0.0-alpha.6).
We are currently working to provide an upgraded API across all the languages supported by the Zenoh ecosystem.
This last alpha release still offers an 'old-fashioned' API, although it's fully
compatible with the other 1.0.0 alpha releases of Zenoh. You must take into consideration when importing this library
With the purpose of providing an upgraded API across all the languages supported by the Zenoh ecosystem,
we are currently releasing a series of alpha and beta versions, the latest one being currently the
[1.0.0-beta.1](https://github.com/eclipse-zenoh/zenoh-java/releases/tag/1.0.0-beta.1).

This last release still offers an 'old-fashioned' API, although it's fully
compatible with the other 1.0.0 releases of Zenoh. You must take into consideration when importing this library
that the API is about to be modified with some considerable breaking changes. A migration guide will be provided when
the time comes.

:warning: Note nº2: **Using the `dev/1.0.0` branch**

The `main` branch contains the codebase for the `0.11.0` version of Zenoh-Kotlin,
compatible with the same version of Zenoh. We are currently working with the `dev/1.0.0` branch. So in case you want
to build the project with the latest changes being implemented, switch to that branch!

:warning: Note nº3: **About the released packages**
:warning: Note nº2: **About the released packages**

The released packages can be found in the "packages" section of this repository, or in the links below:
* [Android packages](https://github.com/eclipse-zenoh/zenoh-java/packages/2019754/versions)
Expand Down

0 comments on commit f9b78d0

Please sign in to comment.