summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2021-05-15 18:00:26 +0300
committerYuval Adam <_@yuv.al>2021-05-15 18:00:26 +0300
commitf460b8893d263aabcfc5018d72225e860cf9a811 (patch)
treef0b2a200f664b020c68db2e557c9578ca81e3931 /README.md
parent74139a918e0867f5be785b953a2fb838809563bb (diff)
Update README usage and bump to v1.0.4v1.0.4
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 23 insertions, 2 deletions
diff --git a/README.md b/README.md
index d99c3fe..c67c4db 100644
--- a/README.md
+++ b/README.md
@@ -12,13 +12,34 @@ This tool is based on an unofficial API, and cannot be guaranteed to show correc
Further fine-print covering the terms of use of this tool can be found in the [GPLv3 license](LICENSE) file.
-## Usage
+## Install
+
+### Pip
+
+The easiest way to install is from PyPI with `pip`:
+
+```bash
+$ pip install alarmpy
+```
+
+You can then run the `alarmpy` executable directly:
```bash
-$ pipenv sync
+$ alarmpy --help
+```
+
+### Pipenv
+
+For development usage it's recommended to clone the git repo and use `pipenv`:
+
+```bash
+$ git clone https://github.com/yuvadm/alarmpy
+$ pipenv sync -d
$ pipenv run alarmpy
```
+## Usage
+
Advanced flags can be set as described in the usage:
```bash