From 8dae4bb1b88ba358b980ad04d6466ecab3291d9b Mon Sep 17 00:00:00 2001
From: Nick Cross <ncross@redhat.com>
Date: Thu, 19 Dec 2024 14:05:48 +0000
Subject: [PATCH] Documentation

---
 README.md                                     | 36 ++++++++++++++++++-
 .../konfluxtooling/prebuild/Preprocessor.java |  1 -
 2 files changed, 35 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 2d632bf..7999606 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,35 @@
-# konflux-tooling
\ No newline at end of file
+# Konflux Tooling
+
+This contains the tooling needed by PNC when running within a Konflux pipeline. The following 'mini-tools' are
+provided, all of which are intended to be called from a Tekton pipeline e.g.
+
+```
+    - name: deploy
+      image: $(params.JVM_BUILD_SERVICE_REQPROCESSOR_IMAGE)
+      securityContext:
+        runAsUser: 0
+      volumeMounts:
+        - mountPath: /mnt/trusted-ca
+          name: trusted-ca
+          readOnly: true
+      env:
+        - name: ACCESS_TOKEN
+          value: $(params.ACCESS_TOKEN)
+      args:
+        - deploy
+        - --directory=/var/workdir/deployment
+        - --mvn-repo=$(params.MVN_REPO)
+        - --mvn-username=$(params.MVN_USERNAME)
+        - --server-id=$(params.MVN_SERVER_ID)
+
+```
+
+The current tools are:
+
+* Preprocessor : used to preprocess build sources to add a build script and Containerfile.
+* Deploy: used (with MavenRepositoryDeployer) to deploy files to a maven repository.
+* CopyArtifacts: used by Ant builds to move built artifacts to the correct location.
+* Notify: used to notify PNC components that a pipeline has finished.
+
+
+It is deployed as an image to https://quay.io/repository/redhat-user-workloads/konflux-jbs-pnc-tenant/konflux-tooling?tab=tags&tag=latest
diff --git a/src/main/java/org/jboss/pnc/konfluxtooling/prebuild/Preprocessor.java b/src/main/java/org/jboss/pnc/konfluxtooling/prebuild/Preprocessor.java
index b28f1ee..f51844e 100644
--- a/src/main/java/org/jboss/pnc/konfluxtooling/prebuild/Preprocessor.java
+++ b/src/main/java/org/jboss/pnc/konfluxtooling/prebuild/Preprocessor.java
@@ -13,7 +13,6 @@
 
 /**
  * We keep all the options the same between maven, gradle, sbt and ant for now to keep the pipeline setup simpler.
- * Some of these may be ignored by different processors
  */
 @CommandLine.Command(name = "prepare")
 public class Preprocessor implements Runnable {