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 +++++++++++++++++++++++-- setup.py | 2 +- 2 files changed, 24 insertions(+), 3 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 diff --git a/setup.py b/setup.py index 3fd3605..a9c81df 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as fh: setuptools.setup( name="alarmpy", - version="1.0.3", + version="1.0.4", author="Yuval Adam", author_email="_@yuv.al", description="Pikud Ha'oref Alarm Tracking", -- cgit v1.3.1