summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2023-10-12 12:13:00 +0200
committerYuval Adam <_@yuv.al>2023-10-12 12:13:00 +0200
commitcd7d0d7ba3c6ba53e66c6169f1cac8e55ef39d1b (patch)
tree658936efb07f3b6259f5455fd22a0ce70cd1a7fc /README.md
parent8a17a42de3e6bc64f855131ec0360f78211cdd2b (diff)
Add --mirror flag and release v1.6.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index bfd6f11..4124c25 100644
--- a/README.md
+++ b/README.md
@@ -56,10 +56,16 @@ $ alarmpy
- In case of RTL issues in the terminal use `--reverse` to output all names in reverse.
- Use `--highlight abc` in order to highlight any alarm which contains the string `abc`.
-### Proxy
+### Proxy and Mirror Servers
The unofficial API is limited for use for Israeli-originating IPs only. In order to use alarmpy from outside Israel, users must route traffic through an Israeli exit point. The `HTTPS_PROXY` environment variable is supported for this use case.
+Alternatively, a well-known mirror URL can be used:
+
+```bash
+$ alarmpy --mirror http://alarmpy.yuv.al/alerts.json
+```
+
### Advanced
Advanced flags can be set as described in the usage: