From 1941ce2b6396d60bb466fcdb21940b89e4635807 Mon Sep 17 00:00:00 2001
From: Itxaka <itxaka@kairos.io>
Date: Thu, 5 Dec 2024 15:59:09 +0100
Subject: [PATCH] Add overrides entry to the readme

Signed-off-by: Itxaka <itxaka@kairos.io>
---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 6f3da87d..1648022b 100644
--- a/README.md
+++ b/README.md
@@ -447,6 +447,13 @@ stages:
 
 A list of systemd services to `enable`, `disable`, `mask` or `start`.
 
+A list of overrides to apply to the service files witht he following fields:
+ - `service`: The service name to add the override for. Required. `.service` extension is appended to the name if not provided.
+   - `name`: The name of the override file. Optional, if not provided it will be named `override-yip.conf`. `.conf` extension is appended to the name if not provided.
+ - `content`: The content of the override file.
+
+Overrides don't check if the service is enabled or disabled, or even if it exists, it will apply the override anyway.
+
 ```yaml
 stages:
    default:
@@ -461,6 +468,13 @@ stages:
           - crond
          start:
           - cronie
+         overrides:
+            - service: "systemd-timesyncd"
+              name: "override-custom.conf"
+              content: |
+                [Service]
+                ExecStart=
+                ExecStart=/usr/lib/systemd/systemd-timesyncd
 ```
 ### `stages.<stageID>.[<stepN>].environment`