From b300727c1881a591a24f39a3730810f93bd43245 Mon Sep 17 00:00:00 2001
From: Arun Isaac
Date: Mon, 1 Sep 2025 17:03:22 +0100
Subject: Do not require output ciphertext file path.

Make output ciphertext file path implicit; infer it by appending
".hegp" to the plaintext file. We take inspiration from GnuPG.
---
 README.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 81c153c..ee7057f 100644
--- a/README.md
+++ b/README.md
@@ -65,9 +65,9 @@ pyhegp --help
 
 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
+pyhegp encrypt 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`.
+They then send the encrypted data `genotype.tsv.hegp` 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
 
@@ -83,11 +83,11 @@ pyhegp pool -o complete-summary summary1 summary2 ...
 ```
 The data broker shares these summary statistics with the data owners. The data owners standardize their data using these summary statistics, and encrypt their data using a random key.
 ```
-pyhegp encrypt -s complete-summary -o encrypted-genotype.tsv genotype.tsv
+pyhegp encrypt -s complete-summary genotype.tsv
 ```
-Finally, the data owners share the encrypted data with the broker who concatenates it and shares it with all parties.
+Finally, the data owners share the encrypted data `genotype.tsv.hegp` with the broker who concatenates it and shares it with all parties.
 ```
-pyhegp cat -o complete-encrypted-genotype.tsv encrypted-genotype1.tsv encrypted-genotype2.tsv ...
+pyhegp cat -o complete-genotype.tsv.hegp genotype1.tsv.hegp genotype2.tsv.hegp ...
 ```
 Note that all data sharing is carried out-of-band and is outside the scope of `pyhegp`.
 
-- 
cgit 1.4.1