docs: standardize and validate plugin READMEs
This commit is contained in:
@@ -1,10 +1,34 @@
|
||||
# Daily Wallpaper
|
||||
|
||||
Fetches a daily wallpaper from Bing or NASA and applies it through the Noctalia 5 wallpaper API.
|
||||
Daily Wallpaper fetches Bing's image of the day or NASA's image of the day and
|
||||
applies it through Noctalia's wallpaper API.
|
||||
|
||||
The service checks on startup and then every 10 minutes. It downloads at most one image per source and Bing locale per day, stores its files in a dedicated `daily-wallpaper` directory, and removes cached images older than 5 days. Repeated failures are logged, but error notifications are limited to once per day.
|
||||
## Plugin
|
||||
|
||||
Settings:
|
||||
| Field | Value |
|
||||
| --- | --- |
|
||||
| ID | `nzlov/daily-wallpaper` |
|
||||
| Entry | Service: `service` |
|
||||
|
||||
- Source: Bing or NASA.
|
||||
- Locale: Bing market locale such as `en-US`, `de-DE`, or `fr-FR`. NASA ignores this setting.
|
||||
## Usage
|
||||
|
||||
Enable the plugin in Settings → Plugins. Its headless service checks for the
|
||||
current image on startup and every ten minutes, applying at most one new image
|
||||
per source and Bing locale each day.
|
||||
|
||||
Choose Bing or NASA under the plugin's settings. Bing accepts a market locale
|
||||
such as `en-US`, `de-DE`, or `fr-FR`; NASA ignores the locale setting.
|
||||
|
||||
## Settings
|
||||
|
||||
| Setting | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| `source` | `select` | `bing` | Selects Bing or NASA as the daily image source. |
|
||||
| `locale` | `string` | *(automatic)* | Bing market locale; an empty value uses the service default. |
|
||||
|
||||
## Notes
|
||||
|
||||
The service contacts the selected provider and downloads images into a
|
||||
dedicated `daily-wallpaper` cache directory. It removes cached images older
|
||||
than five days. Repeated failures are logged, but error notifications are
|
||||
limited to once per day.
|
||||
|
||||
Reference in New Issue
Block a user