Skip to content

Commit 9d22014

Browse files
committed
[infrastructure] improve documentation (smarthomej#249)
Signed-off-by: Jan N. Klug <[email protected]>
1 parent 0d5ebeb commit 9d22014

File tree

2 files changed

+9
-21
lines changed

2 files changed

+9
-21
lines changed

README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@ Some parts of this repository are forked from [openHAB Addons](https://github.co
99

1010
## Installation / Usage
1111

12-
The easiest way to use the bindings in this repository is to install the SmartHome/J repository manager.
12+
The easiest way to use the bindings in this repository with openHAB 3.0.x/3.1.x is to install the SmartHome/J repository manager.
1313
The documentation can be found [here](https://github.com/smarthomej/addons/tree/main/bundles/org.smarthomej.io.repomanager).
1414

15-
***Attention:*** Due to a breaking change related to the Community Marketplace in openHAB 3.2.0.M3 and later the Repomanager is no longer compatible.
16-
A replacement will be added as soon as possible.
15+
For openHAB 3.2.0 and later it is recommended to add `https://download.smarthomej.org/addons.json` as JSON 3rd Party Addon Service in the settings.
16+
Afterwards all addons can be installed from the UI.
1717

1818
### Compatibility
1919

2020
Due to a breaking changes in openHAB, older and newer versions of bundles are not compatible in every combination.
2121
We'll continue to support 3.0 compatible addons until the release of openHAB 3.2.0 (which is expected end of 2021) and provide the same set of addons for newer versions.
2222
Please check the table to see which versions of SmartHome/J are compatible with which openHAB version:
2323

24-
| | openHAB 3.0.x (milestones, releases) | openHAB 3.1.0 (milestones <= M3) | openHAB 3.1.0 (milestone M4) | openHAB 3.1.0 (milestone M5, release) | openHAB 3.2.0 (milestone <= M2)| openhab 3.2.0 (milestone M3) |
25-
|---|:---:|:---:|:---:|:---:|:---:|:---:|
26-
| SmartHome/J 3.1.x (snapshots, releases) | yes | yes | no | no | no | no |
27-
| SmartHome/J 3.2.0 (snapshots, releases) | no | no | no | yes | yes | yes |
28-
| compatible RepoManager | [latest 3.1.x](https://download.smarthomej.org/repomanager-latest) | [latest 3.1.x](https://download.smarthomej.org/repomanager-latest) | - | [latest 3.2.x](https://download.smarthomej.org/repomanager-latest-3.2.x) | [latest 3.2.x](https://download.smarthomej.org/repomanager-latest-3.2.x) | - |
24+
| | openHAB 3.0.x (releases) | openHAB 3.1.x (releases) | openHAB 3.2.0 (release) | openHAB 3.3.0 (snapshots) |
25+
|---|:---:|:---:|:---:|:---:|
26+
| SmartHome/J 3.1.x (snapshots, releases) | yes | no | no | no |
27+
| SmartHome/J 3.2.x (snapshots, releases) | no | yes | yes| yes |
28+
| compatible RepoManager | [latest 3.1.x](https://download.smarthomej.org/repomanager-latest) | [latest 3.2.x](https://download.smarthomej.org/repomanager-latest-3.2.x) | JSON AddonService | JSON AddonService |
2929

3030
## Development
3131

@@ -38,5 +38,5 @@ The following differences apply:
3838
- null checks: annotations are required
3939

4040
Happy coding!
41-
Pull requests always welcome and we'll try to review as soon as possible.
41+
Pull requests always welcome, and we'll try to review as soon as possible.
4242
In case you need assistance, feel free to ask.

bundles/org.smarthomej.io.repomanager/README.md

-12
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,6 @@ Make the repository manager bundle available to your openHAB 3 or openHAB 3 comp
99
For openHAB this is as simple as dropping the .jar-file in the addons folder.
1010
After that a new servlet is installed with the URL `/repomanager`, e.g. `http://openhab:8080/repomanager`.
1111

12-
### Compatibility
13-
14-
Due to a breaking change in openHAB 3.1 (starting with SNAPSHOT #2305), older and newer versions of bundles are no longer compatible.
15-
We'll continue to support 3.0 compatible addons until further notice and provide the same set of addons for newer versions.
16-
Please check the table to see which versions of SmartHome/J are compatible with which openHAB version:
17-
18-
| | openHAB 3.0.x (snapshots, milestones, releases) | openHAB 3.1.0 (snapshots <= #2305, milestones <= M3) | openHAB 3.1.0 (snapshots > #2305, milestones > M3 |
19-
|---|:---:|:---:|:---:|
20-
| SmartHome/J 3.1.x (snapshots, releases) | yes | yes | no |
21-
| SmartHome/J 3.2.0 (snapshots, releases) | no | no | yes |
22-
| compatible RepoManager | [latest 3.1.x](https://download.smarthomej.org/repomanager-latest) | [latest 3.1.x](https://download.smarthomej.org/repomanager-latest) | [latest 3.2.x](https://download.smarthomej.org/repomanager-latest-3.2.x) |
23-
2412
## Repository Administration
2513

2614
The page is divided in two sections: Snapshot and Release.

0 commit comments

Comments
 (0)