From f460b8893d263aabcfc5018d72225e860cf9a811 Mon Sep 17 00:00:00 2001
From: Yuval Adam <_@yuv.al>
Date: Sat, 15 May 2021 18:00:26 +0300
Subject: Update README usage and bump to v1.0.4

---
 README.md | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)

(limited to 'README.md')

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
-- 
cgit v1.3.1