Skip to content

Commit 415f181

Browse files
committed
Readme: Add compatiblity table
1 parent ab18f73 commit 415f181

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ API. It enables the automatic creation of new machines in NetBox or population o
1313
**Nazara is in the early stages of its development. Please note that the information listed below is subject to change.**
1414

1515
> [!Note]
16-
> Nazara is currently in an alpha state. Bugs are bound to happen. If you encounter any, please [report them](https://github.com/The-Nazara-Project/Nazara/issues).
16+
> Nazara is currently in a beta state. Bugs are bound to happen. If you encounter any, please [report them](https://github.com/The-Nazara-Project/Nazara/issues).
1717
>
1818
> Furthermore, **Nazara currently does not support custom fields for any NetBox object**. Though, this is the next item on our agenda.
1919
@@ -28,6 +28,16 @@ API. It enables the automatic creation of new machines in NetBox or population o
2828
- [Contributing](#contributing)
2929
- [License](#license)
3030

31+
# Compatibility
32+
33+
We strive to make sure to stay compatible with the most recent NetBox version. Here you can see which version of Nazar is compatible with which version of NetBox.
34+
When major Ports to newer NetBox versions happen - which usually include breaking changes - the old version of Nazara will be moved to its own branch and tagged accordingly.
35+
Maintenance work on these older versions is not planned.
36+
37+
|Nazara Version|NetBox Version|Branch|maintained?|
38+
|-|-|-|-|
39+
|`v0.1.0_beta.1`|`v4.3.x`|`main`|:white_check_mark:|
40+
|`v0.1.0_alpha.2|`v3.6.x`|`version/alpha-2`|:x:|
3141

3242
# Installation
3343

@@ -66,7 +76,7 @@ configuring all of these parameters inside the [configuration file](#configuring
6676
After that, simply run
6777

6878
```bash
69-
nazara
79+
sudo nazara
7080
```
7181

7282
in your terminal. Nazara will automatically collect all required system information and decide whether to create a new device, or update an existing entry.

0 commit comments

Comments
 (0)