summaryrefslogtreecommitdiff
path: root/branding/motd-cli/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'branding/motd-cli/README.md')
-rw-r--r--branding/motd-cli/README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/branding/motd-cli/README.md b/branding/motd-cli/README.md
index cfe8a38..5d00f10 100644
--- a/branding/motd-cli/README.md
+++ b/branding/motd-cli/README.md
@@ -19,6 +19,7 @@ The structure of the `motd.json` file is like follows:
"end": "Dec 31 2021 23:59:00",
"type": "daily",
"platform": "all",
+ "urgency": "normal",
"text": [
{ "lang": "en",
"str": "This is a <a href='https://leap.se'>test!</a>"},
@@ -33,7 +34,8 @@ Valid values are:
* Begin, End are date strings, like "Jan 1 2021 00:00:00".
* Type: "once" for a one-shot message, "daily" for a message that is displayed daily during the specified duration.
-* Platform: one of "windows", "linux", "osx" or "all".
+* Platform: one of "windows", "osx", "snap", "linux", or "all".
+* Urgency: either "normal" or "critical".
The text message can contain links.
@@ -48,9 +50,12 @@ Message 1 ✓
-----------
Type: daily ✓
Platform: all ✓
+Urgency: normal ✓
Languages: 2 ✓
```
+Use `motd-cli -url https://example.com/motd.json` to validate a remote file.
+
Notes: I'm considering adding an explicit layer of verification of the motd
payload. Please comment on
[#554](https://0xacab.org/leap/bitmask-vpn/-/issues/554) if you have an opinion