From f1a1d803b9bff63b539be67328cfb987aef8a59b Mon Sep 17 00:00:00 2001
From: Nicolas MASSE <nicolas.masse@itix.fr>
Date: Tue, 30 Nov 2021 16:55:14 +0100
Subject: [PATCH] add documentation about the container image

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index a5010c8..57adb16 100644
--- a/README.md
+++ b/README.md
@@ -48,3 +48,18 @@ You can change this with:
 ```sh
 kci config set workers --value 10
 ```
+
+## Container image
+
+An up-to-date container image is built by a Tekton pipeline and pushed to [quay.io/itix/kci](https://quay.io/repository/itix/kci?tab=tags).
+Images are built for x86_64, armv5 and arm64.
+Each tag in the git repository ends up being a tag in the Quay registry, `latest` being the continuous build of the `main` branch.
+
+To use this tool from the command line with podman, you would need to define the following function in your .bashrc / .zshrc.
+
+```sh
+function kci () {
+    touch ~/.kci.yaml
+    podman run --rm -v $HOME/.kci.yaml:/.kci.yaml:z -v $PWD:/home:z -w /home quay.io/itix/kci:latest "$@"
+}
+```