From fb4cf5b96e94ff40ae0c641faafde96cb0e1c7ef Mon Sep 17 00:00:00 2001
From: Noratrieb <48135649+Noratrieb@users.noreply.github.com>
Date: Mon, 10 Nov 2025 20:43:46 +0100
Subject: [PATCH] readme

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 9752465..72db0bc 100644
--- a/README.md
+++ b/README.md
@@ -12,9 +12,21 @@ It does this in parallel, using half of the available threads (or `DOES_IT_BUILD
 
 - `DB_PATH`: Path to SQlite DB to store the results
 - `DOES_IT_BUILD_PARALLEL_JOBS`: Parallel build jobs, defaults to cores/2.
+- `GITHUB_SEND_PINGS`: If this is set, actual pings will be sent for notification issues
+- `GITHUB_OWNER`: The owner of the notification repo
+- `GITHUB_REPO`: The repo name of the notification repo
+- `GITHUB_APP_ID`: The app ID of the notification GitHub app
+- `GITHUB_APP_PRIVATE_KEY`: The RSA private key for the notification GitHub app
 
 Build configuration: `DOES_IT_BUILD_OVERRIDE_VERSION` to override the git commit.
 
 ## Deployment
 
 deployed at <https://does-it-build.noratrieb.dev/>
+
+## Notification
+
+does-it-build supports sending target maintainer notifications on breakage.
+
+It does this by creating an issue <https://github.com/Noratrieb/does-it-build-notifications> that pings the registered maintainers.
+There is an array in the source code (linked to on the website target page) where people can add or remove themselves.