docs: standardize and validate plugin READMEs
This commit is contained in:
+29
-2
@@ -1,3 +1,30 @@
|
||||
# Upbeat
|
||||

|
||||
**Upbeat** is a bar widget plugin written for Noctalia (v5) that displays the current Internet Time. Internet time is a subversive, yet extremely accurate and location agnostic way of telling time created in the 90s for the purpose of communicating in the future. Also it's kinda funny.
|
||||
|
||||
Upbeat adds a bar widget that displays Swatch Internet Time, a timezone-neutral
|
||||
decimal time system measured in beats and centibeats.
|
||||
|
||||
## Plugin
|
||||
|
||||
| Field | Value |
|
||||
| --- | --- |
|
||||
| ID | `neuro/upbeat` |
|
||||
| Entry | Bar widget: `upbeat` |
|
||||
|
||||
## Usage
|
||||
|
||||
Add the `upbeat` widget from Noctalia's widget picker. The widget displays the
|
||||
current Internet Time at UTC+1; hover it to see conventional local time in the
|
||||
configured 12- or 24-hour format.
|
||||
|
||||
## Settings
|
||||
|
||||
| Setting | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `show_centibeats` | `bool` | `true` | Shows two centibeat digits after the decimal point. |
|
||||
| `beat_display` | `bool` | `false` | Appends the `.beats` label to the value. |
|
||||
| `time_format_toggle` | `bool` | `false` | Uses 24-hour time instead of 12-hour time in the tooltip. |
|
||||
|
||||
## Notes
|
||||
|
||||
Internet Time is computed locally and does not contact a network service. The
|
||||
widget updates more frequently when centibeats are displayed.
|
||||
|
||||
Reference in New Issue
Block a user