From 5ef84f99b35c6d06771f04ddd5a90f69a207e710 Mon Sep 17 00:00:00 2001 From: "M.J. Wydra (Jay)" Date: Fri, 4 Dec 2020 21:13:05 -0600 Subject: [PATCH] Add reference to Docker Hub --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index a81e6a9..e75cb27 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,11 @@ I thought of this project when I switched to using my old laptop as my Home Assi `battery2mqtt` can monitor current battery percentage, charging status, etc. for any batteries present at `/sys/class/power_supply`. The MQTT topic format is `battery2mqtt/$TOPIC/$NAME` where `$TOPIC` is the topic you define and `$NAME` is the name of each battery. For example, if `/sys/class/power_supply/BAT0` is present in your system and you choose `server` to be the topic, the full topic will be `battery2mqtt/server/BAT0`. # Instructions + +**Option 1: Pull from Docker Hub** +`docker pull tediore/battery2mqtt:latest` + +**Option 2: Manual build** 1. Clone repo: `git clone https://github.com/Tediore/battery2mqtt` 2. Enter directory: `cd battery2mqtt` 3. Build image: `docker build . -t battery2mqtt`