From 7c905c2ca9edb962cb8f74b484e4268339f22f96 Mon Sep 17 00:00:00 2001
From: Assil Ksiksi <assil@ksiksi.net>
Date: Sat, 28 Sep 2024 15:55:49 -0400
Subject: [PATCH] update README

---
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 140f9c6..f12f836 100644
--- a/README.md
+++ b/README.md
@@ -196,6 +196,29 @@ You can do one of the following:
 sudo systemctl start podman-compose-myservice-root.target
 ```
 
+#### Compose Build spec
+
+`compose2nix` has basic support for the Build spec. See [Supported Compose Features] below for details.
+
+By default, a systemd service will be generated for _each_ container build. This is a
+one-shot service that simply runs the build when started.
+
+For example, if you have a service named `my-service` with a `build` set:
+
+```
+sudo systemctl start podman-build-my-service.service
+```
+
+Note that, until this is run, the container for `my-service` will **not be able to start** due to the missing image.
+
+##### Auto-build
+
+If you run the CLI with `-build=true`, the systemd service will be marked as a dependency for the service
+container. This means that the build will be run before the container is started.
+
+However, it is important to note that the build will be re-run on every restart of the root target or system.
+This will result in the build image being updated (potentially).
+
 ### Nvidia GPU Support
 
 1. Enable CDI support in your NixOS config:
@@ -336,7 +359,7 @@ Usage of compose2nix:
     	if true, Nix setup code is written to output (runtime, DNS, autoprune, etc.) (default true)
 ```
 
-### Supported Docker Compose Features
+### Supported Compose Features
 
 If a feature is missing, please feel free to [create an issue](https://github.com/aksiksi/compose2nix/issues/new). In theory, any Compose feature can be supported because `compose2nix` uses the same library as the Docker CLI under the hood.
 
@@ -400,6 +423,16 @@ If a feature is missing, please feel free to [create an issue](https://github.co
 | [`name`](https://docs.docker.com/compose/compose-file/07-volumes/#name) | ✅ |
 | [`external`](https://docs.docker.com/compose/compose-file/07-volumes/#external) | ✅ |
 
+#### [`build`](https://docs.docker.com/reference/compose-file/build/)
+
+|   |     | Notes |
+|---|:---:|-------|
+| [`args`](https://docs.docker.com/reference/compose-file/build/#args) | ✅ | |
+| [`tags`](https://docs.docker.com/reference/compose-file/build/#tags) | ✅ |
+| [`context`](https://docs.docker.com/reference/compose-file/build/#context) | ⚠️  | Git repo is not supported |
+| [`network`](https://docs.docker.com/reference/compose-file/build/#network) | ❌ |
+| [`image`+`build`](https://docs.docker.com/reference/compose-file/build/#using-build-and-image) | ❌ |
+
 #### Misc
 
 * [`name`](https://docs.docker.com/compose/compose-file/04-version-and-name/#name-top-level-element) - ✅