Skip to content

Commit 41500f9

Browse files
committed
Merge branch 'dev/1.0.0' of github.com:eclipse-zenoh/zenoh-java into dev/1.0.0
2 parents 302947e + 7d4566e commit 41500f9

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,33 @@ Alternatively, you can build it locally as [explained below](#building-the-docum
3535
----
3636
# How to import
3737

38+
39+
:warning: Note nº1: **Breaking changes incoming**
40+
41+
We are currently releasing a series of alpha versions, the latests one being currently the
42+
[1.0.0-alpha.6](https://github.com/eclipse-zenoh/zenoh-java/releases/tag/1.0.0-alpha.6).
43+
We are currently working to provide an upgraded API across all the languages supported by the Zenoh ecosystem.
44+
This last alpha release still offers an 'old-fashioned' API, although it's fully
45+
compatible with the other 1.0.0 alpha releases of Zenoh. You must take into consideration when importing this library
46+
that the API is about to be modified with some considerable breaking changes. A migration guide will be provided when
47+
the time comes.
48+
49+
:warning: Note nº2: **Using the `dev/1.0.0` branch**
50+
51+
The `main` branch contains the codebase for the `0.11.0` version of Zenoh-Kotlin,
52+
compatible with the same version of Zenoh. We are currently working with the `dev/1.0.0` branch. So in case you want
53+
to build the project with the latest changes being implemented, switch to that branch!
54+
55+
:warning: Note nº3: **About the released packages**
56+
57+
The released packages can be found in the "packages" section of this repository, or in the links below:
58+
* [Android packages](https://github.com/eclipse-zenoh/zenoh-java/packages/2019754/versions)
59+
* [JVM packages](https://github.com/eclipse-zenoh/zenoh-java/packages/2017294/versions)
60+
61+
These are 'nightly' packages that need to be imported as explained in the following sections of this README.
62+
We plan to publish our packages into Maven central for the `1.0.0` stable release.
63+
64+
3865
## <img src="android-robot.png" alt="Android" height="50"> For Android applications
3966

4067
For this first version we have published a [Github package](https://github.com/eclipse-zenoh/zenoh-java/packages/2019754) with the library which can be imported on your projects.

0 commit comments

Comments
 (0)