From b86df76fb6bd01b91cd12ba5d1c4e6e20e5b58bb Mon Sep 17 00:00:00 2001
From: mag37
Date: Sun, 4 Feb 2024 21:15:21 +0100
Subject: [PATCH] tidying some
Rephrased and reordered readme.
Removed "coded by human" - I cant know what contributors use :)
---
README.md | 27 ++++++++++++---------------
1 file changed, 12 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md
index d85dfb7..e31d9ed 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,6 @@
-
@@ -11,9 +10,9 @@
-A script checking updates for docker images without pulling
Then selectively auto-update containers.
-Now with a simple Apprise integration!
-With features like excluding specific containers, filter by name, auto-prune dangling images and more.
+CLI tool to automate docker image updates.
No pre-pull, selective, optional notifications and prune when done.
+Now with simple notification integrations!
+With features like excluding specific containers, custom container labels, auto-prune when done and more.
___
## :bell: Changelog
@@ -23,17 +22,6 @@ ___
- **v0.3.7**: Added support for [labels](#bookmark-labels), added the `-f` option (force restart stack).
- **v0.3.6**: Added pushbullet template.
- **v0.3.5**: Added a simple progress bar for the registry checkup.
-- **v0.3.4**: Added ntfy.sh template and error message on registry fail.
-- **v0.3.3**: Added Apprise template and the option `-i` inform - to send notifications.
-- **v0.3.2**: Added a notify function to wrap a notify-script, currently DSM/Ssmtp + template script.
-
-___
-
-## :nut_and_bolt: Dependencies
-- Running docker (duh) and compose, either standalone or plugin.
-- [regclient/regctl](https://github.com/regclient/regclient) (Licensed under [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0))
- - User will be prompted to download `regctl` if not in `PATH` or `PWD`.
- - regctl requires `amd64/arm64` - see [workaround](#roller_coaster-workaround-for-non-amd64--arm64) if other architecture is used.
___
@@ -81,6 +69,15 @@ Enter number(s) separated by comma, [a] for all - [q] to quit:
Then it proceedes to run `pull` and `up -d` on every container with updates.
After the updates are complete, you'll get prompted if you'd like to prune dangling images.
+___
+
+## :nut_and_bolt: Dependencies
+- Running docker (duh) and compose, either standalone or plugin.
+- [regclient/regctl](https://github.com/regclient/regclient) (Licensed under [Apache-2.0 License](http://www.apache.org/licenses/LICENSE-2.0))
+ - User will be prompted to download `regctl` if not in `PATH` or `PWD`.
+ - regctl requires `amd64/arm64` - see [workaround](#roller_coaster-workaround-for-non-amd64--arm64) if other architecture is used.
+
+
## :loudspeaker: Notifications
Trigger with the `-i` flag.
Run it scheduled with `-ni` to only get notified when there's updates available!