Update readme

This commit is contained in:
Christian Müller 2023-01-19 10:27:59 +01:00
parent f7fd789c27
commit 0025aa8f8a

View file

@ -4,16 +4,32 @@
gonetworkmanager
================
Go D-Bus bindings for NetworkManager 1.16.
Tested with NetworkManager 1.16.0.
[NetworkManager 1.16 D-Bus Spec](https://developer.gnome.org/NetworkManager/1.16/spec.html)
## Backward compatibility
The library should also be compatible with NetworkManager 0.9.8.10.
Go D-Bus bindings for [NetworkManager](https://networkmanager.dev/).
## Usage
You can find some examples in the [examples](examples) directory.
## External documentations
- [NetworkManager D-Bus Spec](https://networkmanager.dev/docs/api/latest/spec.html)
- [nm-settings-dbus](https://networkmanager.dev/docs/api/latest/nm-settings-dbus.html)
## Backward compatibility
The library is most likely compatible with NetworkManager 0.9 to 1.40.
## Tests
Tested with NetworkManager 1.40.0.
There are no automated tests for this library. Tests are made manually on a best-effort basis. Unit tests PRs are welcome.
## Development and contributions
There is no active development workforce from the maintainer. PRs are welcome.
## Issues
Before reporting an issue, please test the scenario with nmcli (if possible) to ensure the problem comes from the library.