From 3eb6894a18a1914fc6bb2ec4dfd31bfa24b0202c Mon Sep 17 00:00:00 2001
From: Adar Nimrod <nimrod@shore.co.il>
Date: Sat, 14 May 2022 00:21:02 +0300
Subject: [PATCH] Update README.

- Update the usage section.
- Add an explanation.
---
 README.rst | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

diff --git a/README.rst b/README.rst
index b5bc76f..82d3090 100644
--- a/README.rst
+++ b/README.rst
@@ -7,15 +7,34 @@ Deep clean
 
 Clean old versions of Docker images.
 
+Explanation
+-----------
+
+Remove old versions of images with same name. In cases where you updated an
+image (from example from :code:`postgres:13` to :code:`postgres:14`) the old
+image is present. Using :code:`docker image prune` won't help in this case
+since the image is still properly tagged.
+
 Usage
 -----
 
 .. code:: shell
 
-   usage: deepclean [-h]
-   Clean old versions of Docker images.
-   optional arguments:
-     -h, --help  show this help message and exit
+    usage: deepclean [-h] [-i INCLUDE] [-e EXCLUDE] [-v] [-V] [-d]
+
+    Clean old versions of Docker images.
+
+    options:
+      -h, --help            show this help message and exit
+      -i INCLUDE, --include INCLUDE
+                            Regular expression of images to exclusively prune.
+      -e EXCLUDE, --exclude EXCLUDE
+                            Regular expression of images to ignore.
+      -v, --verbose         Verbose output
+      -V, --version         show program's version number and exit
+      -d, --dry-run         Dry-run, don't delete
+
+    Regular Docker environment variables (like DOCKER_HOST) can be used.-i and -e can be used multiple times.
 
 License
 -------
-- 
GitLab