Docs

Author: AB-xdev

README.md

@@ -2,8 +2,20 @@
 [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/testcontainers-java-advanced-imagebuilder/checkBuild.yml?branch=develop)](https://github.com/xdev-software/testcontainers-java-advanced-imagebuilder/actions/workflows/checkBuild.yml?query=branch%3Adevelop)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_testcontainers-java-advanced-imagebuilder&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_testcontainers-java-advanced-imagebuilder)
 
-# testcontainers-java-advanced-imagebuilder
+# Advanced Image-Builder for Testcontainers Java
 
+A re-implementation of [Testcontainers Image-Builder](https://java.testcontainers.org/features/creating_images/) with the following improvements:
+* Allows passing a custom logger to the image build - [testcontainers-java#3093](https://github.com/testcontainers/testcontainers-java/issues/3093)
+* Allows using ``ARG``s for ``FROM`` - [testcontainers-java#3238](https://github.com/testcontainers/testcontainers-java/issues/3238)
+* Brings a custom [build-context](https://docs.docker.com/build/building/context/) processor
+  * Works more efficient and reliable than the default implementation (however likely still not perfect)
+  * uses ``.gitignore`` if available
+  * Allows to adding custom ignores
+    * This way the build-context can be fine tuned in a way that the build cache works very efficiently (e.g. only re-built when actual code that matters changes)
+* Makes logger non generic and therefore controllable
+* Cleaned up some code
+
+A common use case - that can also be seen [inside the demo](./testcontainers-java-advanced-imagebuilder-demo/src/main/java/software/xdev/Application.java) - is for creating an image - used in e.g. Integration tests - for an application that is also inside the same repo.
 
 ## Installation
 [Installation guide for the latest release](https://github.com/xdev-software/testcontainers-java-advanced-imagebuilder/releases/latest#Installation)

testcontainers-java-advanced-imagebuilder/src/main/java/software/xdev/testcontainers/imagebuilder/AdvancedImageFromDockerFile.java

@@ -67,11 +67,7 @@
  * <ul>
  * 	<li><a href="https://github.com/testcontainers/testcontainers-java/issues/3093">testcontainers-java#3093</a></li>
  * 	<li><a href="https://github.com/testcontainers/testcontainers-java/issues/3238">testcontainers-java#3238</a></li>
- * 	<li>
- * 	    Testcontainers internal .dockerignore processor is completely broken: slow (needs ~30s) and misses files -
- * 	    Use own/.gitignore processor (still not perfect but doesn't miss files and runs within 5s).
- * 	    See {@link TransferFilesCreator} for details.
- * 	</li>
+ * 	<li>{@link TransferFilesCreator}</li>
  * 	<li>Fixed: Logger was not controllable (because it was generic)</li>
  *  <li>Deprecated-Stuff replaced / removed</li>
  * </ul>