From 2d3bc78beb8b8dd49c249f08d6ac6590397303ae Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Mon, 5 Oct 2020 21:42:30 +0100 Subject: [PATCH] Add more details to readme --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 49aae58..75b9bc1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ # compose-updater -Simple command to enable updating docker-compose based applications + +![CI](https://github.com/RealOrangeOne/compose-updater/workflows/CI/badge.svg) + +Simple command to enable updating docker-compose based applications. + +If newer containers are available than those running, pull the new containers, and cycle the containers. Supports specifying multiple containers using globs, and multiple globs if necessary. + +## Features + +- Only cycle application if containers were updated (unless `--force-cycle` specified) +- Don't try and update stopped containers (unless `--force-pull` specified) + +## _"How does it work?"_ + +- List images +- If there are images, pull (`docker-compose pull`) +- List images again +- If images list is different, cycle container (`docker-compose down && docker-compose up -d`)