diff --git a/README.md b/README.md index cfb04ac..bfb3dc1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # dockcheck -A repo containing scripts and functions to check docker containers images, repos and registries for updates. +A repo containing scripts and functions to check for docker updates for images, without the need of pulling. With the help of [`regctl`](https://github.com/regclient/regclient). +This is just for fun and inspiration, use with care. + + +# Dependencies: +Running docker (duh) and compose, either standalone or plugin. +`regctl` by [regclient](https://github.com/regclient/regclient) + +# dockcheck_function.sh +Brief function to check a single contianer (by name) if there's any available updates or not without the need of pulling. +`dockcheck nginx` + +# dockcheck.sh +A script to check all currently running containers if they've got updates without pulling images, list them and give the option to update. +