diff --git a/README.md b/README.md index 2fd9d73..13a53e2 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,23 @@ # dockcheck -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. +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 a concept 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. [![asciicast](https://asciinema.org/a/Bt3UXSoDHIRSn0GbvfZmB0tV2.svg)](https://asciinema.org/a/Bt3UXSoDHIRSn0GbvfZmB0tV2) + + +## `dc_function.sh` +Brief function to check a single contianer (by name) if there's any available updates or not **without the need of pulling**. +Preferably placed in `.bashrc` or similar. +Example: +```bash +$ dockcheck nginx +Updates available. +```