diff --git a/docs/modules/Networkmanager.md b/docs/modules/Networkmanager.md index 1c09ad8..6ace464 100644 --- a/docs/modules/Networkmanager.md +++ b/docs/modules/Networkmanager.md @@ -1,4 +1,10 @@ -Displays network connectivity information. Requires NetworkManager. +Displays the current network connection state of NetworkManager. Supports wired ethernet, wifi, +cellular data and VPN connections among others. + +This module uses NetworkManager's so-called primary connection, and therefore inherits its +limitation of only being able to display the "top-level" connection. For example, if we have a VPN +connection over a wifi connection it will only display the former, until it is disconnected, at +which point it will display the latter. A solution to this is currently in the works. ## Configuration @@ -9,57 +15,53 @@ Displays network connectivity information. Requires NetworkManager. | `icon_size` | `integer` | `24` | Size to render icon at. |
-JSON - -```json -{ - "end": [ - { - "type": "networkmanager", - "icon_size": 32 - } - ] -} -``` + JSON + ```json + { + "end": [ + { + "type": "networkmanager", + "icon_size": 32 + } + ] + } + ```
-TOML - -```toml -[[end]] -type = "networkmanager" -icon_size = 32 -``` + TOML + ```toml + [[end]] + type = "networkmanager" + icon_size = 32 + ```
-YAML - -```yaml -end: - - type: "networkmanager" - icon_size: 32 -``` + YAML + ```yaml + end: + - type: "networkmanager" + icon_size: 32 + ```
-Corn - -```corn -{ - end = [ - { - type = "networkmanager" - icon_size = 32 - } - ] -} -``` + Corn + ```corn + { + end = [ + { + type = "networkmanager" + icon_size = 32 + } + ] + } + ```
## Styling