From 85743e96adb937fc812092a81b8233734192213c Mon Sep 17 00:00:00 2001
From: Josef Skladanka <jskladan@redhat.com>
Date: Jun 20 2018 10:28:21 +0000
Subject: Fix Readme


---

diff --git a/README.md b/README.md
index 5e238d7..7aabe3c 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,28 @@
-# task-dockerbuild
+# A task that builds and pushes docker containers
 
-Taskotron task that builds docker images on pagure git commit
\ No newline at end of file
+If the repo/commit in question contain a Dockerfile,
+`.taskotron_task_dockerbuild.json` file, and login/password is provided
+from Vault, then a docker container is built based on the commit and
+pushed.
+
+The `.taskotron_task_dockerbuild.json` file looks like this:
+```
+{
+   "docker_project_name": "resultsdb",
+   "docker_credentials_bucket_uuid": "1e77148e-64ab-11e8-8f59-525400ee7c53",
+   "release_branch": "master"
+}
+```
+
+The images are docker-tagged like this:
+```
+  docker.io/fedoraqa/$PROJECT:$SHA
+  docker.io/fedoraqa/$PROJECT:$BRANCH
+```
+
+`docker_project_name` is the $PROJECT
+`release_branch` is replaced with `latest` for the purpose of tagging
+`docker_credentials_bucket_uuid` is the UUID of Vault provided bucket
+containing the credentials
+
+The Vault bucket has to provide `dockerhub_login` and `dockerhub_password` keys.