From 10dd61fcb29363b82035bac0a5751b090ff48fd8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20Sch=C3=B6ttke?= <c.schoettke@ecoservice.de>
Date: Mon, 30 Mar 2020 16:57:15 +0200
Subject: [PATCH] Add usage info

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e7ef09b..5eb0566 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,22 @@
-# qa-tools
+# Q&A Tools Base Image
 
+Define a base image to use in the different CI stages for Odoo addons.
+
+This image by itself does nothing.
+
+What is defined:
+- A user (`qa-tools`) that runs the command
+- A python virtualenv for python 3.7
+- The `workdir` (`/project`)
+
+What is required:
+- A `requirements.txt` (without it the build process will fail)
+- A `Dockerfile` (see below)
+
+```docker
+FROM docker.ecoservice.de/cicd/qa-tools
+
+COPY <copy the config>
+
+ENTRYPOINT <set the entrypoint>
+```
-- 
GitLab