about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4378456..9fdc466 100644
--- a/README.md
+++ b/README.md
@@ -19,8 +19,19 @@ pip install git+https://github.com/encryption4genetics/pyhegp
 ```
 
 # How to use
+## Simple data sharing
 
-![Workflow](doc/workflow.png)
+![Simple data sharing workflow](doc/simple-workflow.png)
+
+In this simple scenario, there is only one data owner and they wish to share their encrypted data with a researcher. The data owner encrypts their data with:
+```
+pyhegp encrypt -o encrypted-genotype.tsv genotype.tsv
+```
+They then send the encrypted data to the researcher. Note that data sharing is carried out-of-band and is outside the scope of `pyhegp`.
+
+## Joint/federated analysis with many data owners
+
+![Joint/federated analysis workflow](doc/joint-workflow.png)
 
 Data owners generate summary statistics for their data.
 ```