From d270d35cbfe9bc94d1bef16a63e3ca89e87e739e Mon Sep 17 00:00:00 2001
From: Arun Isaac
Date: Thu, 17 Jul 2025 17:59:17 +0100
Subject: Document usage instructions and workflow.

* doc/workflow.uml, doc/workflow.png, doc/generate-images.sh: New
files.
* README.md (How to use): New section.
---
 doc/generate-images.sh |   3 +++
 doc/workflow.png       | Bin 0 -> 27569 bytes
 doc/workflow.uml       |  16 ++++++++++++++++
 3 files changed, 19 insertions(+)
 create mode 100755 doc/generate-images.sh
 create mode 100644 doc/workflow.png
 create mode 100644 doc/workflow.uml

(limited to 'doc')

diff --git a/doc/generate-images.sh b/doc/generate-images.sh
new file mode 100755
index 0000000..e1ee0ba
--- /dev/null
+++ b/doc/generate-images.sh
@@ -0,0 +1,3 @@
+#! /bin/sh
+
+cat workflow.uml | guix shell plantuml -- plantuml -p > workflow.png
diff --git a/doc/workflow.png b/doc/workflow.png
new file mode 100644
index 0000000..b2ff1b2
Binary files /dev/null and b/doc/workflow.png differ
diff --git a/doc/workflow.uml b/doc/workflow.uml
new file mode 100644
index 0000000..2d1542c
--- /dev/null
+++ b/doc/workflow.uml
@@ -0,0 +1,16 @@
+actor "Data Broker" as broker
+actor "Data Owner 1" as owner1
+actor "Data Owner 2" as owner2
+actor "Data Owner 3" as owner3
+owner1 -> broker: Send summary statistics
+owner2 -> broker: Send summary statistics
+owner3 -> broker: Send summary statistics
+broker --> owner1: Send pooled statistics
+broker --> owner2: Send pooled statistics
+broker --> owner3: Send pooled statistics
+owner1 -> broker: Encrypt and share ciphertext
+owner2 -> broker: Encrypt and share ciphertext
+owner3 -> broker: Encrypt and share ciphertext
+broker -> owner1: Share concatenated ciphertext
+broker -> owner2: Share concatenated ciphertext
+broker -> owner3: Share concatenated ciphertext
-- 
cgit v1.2.3