From b11feab4b5b42f07512823ad36c930a8d341b0b8 Mon Sep 17 00:00:00 2001
From: mag37 <robin.ivehult@gmail.com>
Date: Sun, 22 Jan 2023 13:37:28 +0100
Subject: [PATCH] bugs+issues listed

Listed resolved bugs and known issues.
---
 README.md | 21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index ea7f6fd..27087dd 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
 # dockcheck
-### Scripts and functions to check updates for docker images, **without the need of pulling**.   
+### A script to checking updates for docker images **without the need of pulling** then having the option to auto-update through docker compose.
+
 With the help of [`regctl`](https://github.com/regclient/regclient).   
 This is just a concept for fun and inspiration, use with care.
 ___
@@ -11,7 +12,7 @@ The script will ask to download `regctl` if it's not in PATH or current director
 ___
 ## `dockcheck.sh`
 ```bash
-$ dockcheck.sh -h
+$ ./dockcheck.sh -h
 Syntax:     dockcheck.sh [OPTION] [optional string to filter names]
 
 Options:
@@ -23,7 +24,7 @@ A script to check for updates on all currently running containers without pullin
 
 Basic example:
 ```bash
-$ dockcheck.sh
+$ ./dockcheck.sh
 . . .
 Containers with updates available:
 whoogle-search
@@ -41,7 +42,7 @@ Then it proceedes to run `pull` and `up -d` on every container with updates.
 
 And with `-n` *No updates* and `gl` for `*gl*` filtering:
 ```bash
-$ dockcheck.sh -n gl
+$ ./dockcheck.sh -n gl
 . . .
 Containers with updates available:
 whoogle-search
@@ -55,6 +56,18 @@ No updates installed, exiting
 Example-video:   
 ![](https://github.com/mag37/dockcheck/blob/main/example_run.gif)
 
+
+### :beetle: Squashed Bugs:
+- ~~No options for running without updates or auto update.~~
+- ~~No filter to check only specific containers.~~
+- ~~Faulty registry checkups stopped the updates completely.~~
+- ~~No clear checks to skip containers producing errors.~~
+- ~~Multi-digest images didn't correctly check with registry, giving false positives on updates.~~
+
+### :hammer: Known issues
+- No granular choice of what to update (except initial name filter).
+- No detailed error feedback (just skip + list what's skipped) .
+
 ## `dupc_function.sh`
 Function to quickly check for updates on a single contianer or list of containers by name. **Without the need of pulling**.  
 Preferably placed in `.bashrc` or similar.