From 287ca2068ea1f2e9ab01e19d4abeddd6b4e3ae8d Mon Sep 17 00:00:00 2001
From: Daniel <dhaavi@users.noreply.github.com>
Date: Fri, 24 Feb 2023 14:45:38 +0100
Subject: [PATCH] Add README for broadcast notifications

---
 portmaster/README.md | 19 +++++++++++++++++++
 spn/README.md        |  1 -
 2 files changed, 19 insertions(+), 1 deletion(-)
 create mode 100644 portmaster/README.md

diff --git a/portmaster/README.md b/portmaster/README.md
new file mode 100644
index 0000000..2ac2589
--- /dev/null
+++ b/portmaster/README.md
@@ -0,0 +1,19 @@
+# Portmaster Operational Data
+
+### notifications.yaml
+
+Operational messages, warnings and other information broadcasted to all Portmaster instances.
+
+__Testing__
+
+- Put Portmaster into Dev Mode.
+- Run `curl --upload-file notifications.yaml http://127.0.0.1:817/api/v1/broadcasts/simulate`
+
+Other helpful things:
+```
+# View matching data
+curl http://127.0.0.1:817/api/v1/broadcasts/matching-data
+
+# Reset state
+curl -X POST http://127.0.0.1:817/api/v1/broadcasts/reset-state
+```
diff --git a/spn/README.md b/spn/README.md
index f45d4f3..5fbfae8 100644
--- a/spn/README.md
+++ b/spn/README.md
@@ -8,4 +8,3 @@ __Testing__
 
 - Put Portmaster into Dev Mode.
 - Run `curl --upload-file main-intel.yaml http://127.0.0.1:817/api/v1/spn/map/main/intel/update`
-