diff options
| author | Yuval Adam <_@yuv.al> | 2021-05-20 15:40:45 +0300 |
|---|---|---|
| committer | Yuval Adam <_@yuv.al> | 2021-05-20 15:40:45 +0300 |
| commit | 004d7598075a2c627d883f0f67d39fc0b6b34db9 (patch) | |
| tree | 8f6a200d3abf6be40f20f2585d7da2ebfd22a206 /README.md | |
| parent | 59c3d887943e2ef7bfbd5278ac5a33e1b1f51a70 (diff) | |
Expand README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
@@ -44,6 +44,24 @@ $ pipenv run alarmpy ## Usage +For the default usage after installation, just run: + +```bash +$ alarmpy +``` + +### Display + +- Set the output language using `--language [en|he|ar|ru]`, this uses the official city and area name translations for Hebrew, Arabic, English and Russian. +- 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 + +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. + +### Advanced + Advanced flags can be set as described in the usage: ```bash |