diff options
| author | zachir <zachir@librem.one> | 2023-10-19 08:23:38 -0500 |
|---|---|---|
| committer | zachir <zachir@librem.one> | 2023-10-19 08:23:38 -0500 |
| commit | 3a984a9119cf431ec9eba7aafe5baf03376b379e (patch) | |
| tree | 05c23648f9dcbef2cd603e63174099328c364032 /battery-widget | |
| parent | 7090693bcf60efe23a0ce4531b02b6af93cafba8 (diff) | |
Update documentation
Diffstat (limited to 'battery-widget')
| -rw-r--r-- | battery-widget/README.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/battery-widget/README.md b/battery-widget/README.md index b15aac6..8fc07f7 100644 --- a/battery-widget/README.md +++ b/battery-widget/README.md @@ -21,19 +21,19 @@ It is possible to customize widget by providing a table with all or some of the | Name | Default | Description | |---|---|---| -| `font` | Play 8 | Fond | +| `font` | `Play 8` | Font | | `path_to_icons` | `/usr/share/icons/Arc/status/symbolic/` | Path to the folder with icons* | | `show_current_level`| false | Show current charge level | | `margin_right`|0| The right margin of the widget| | `margin_left`|0| The left margin of the widget| -| `display_notification` | `false` | Display a notification on mouseover | +| `display_notification` | false | Display a notification on mouseover | | `notification_position` | `top_right` | The notification position | | `timeout` | 10 | How often in seconds the widget refreshes | -| `warning_msg_title` | _Huston, we have a problem_ | Title of the warning popup | -| `warning_msg_text` | _Battery is dying_ | Text of the warning popup | +| `warning_msg_title` | `Huston, we have a problem` | Title of the warning popup | +| `warning_msg_text` | `Battery is dying` | Text of the warning popup | | `warning_msg_position` | `bottom_right` | Position of the warning popup | -| `warning_msg_icon` | ~/.config/awesome/awesome-wm-widgets/battery-widget/spaceman.jpg | Icon of the warning popup | -| `enable_battery_warning` | `true` | Display low battery warning | +| `warning_msg_icon` | `~/.config/awesome/awesome-wm-widgets/battery-widget/spaceman.jpg` | Icon of the warning popup | +| `enable_battery_warning` | true | Display low battery warning | *Note: the widget expects following icons to be present in the folder: |