From 9333fa2b6522fe872993090747cb741d7f46e8e6 Mon Sep 17 00:00:00 2001
From: Paul Schaub <vanitasvitae@fsfe.org>
Date: Sun, 3 Jan 2021 17:45:05 +0100
Subject: [PATCH] Add README for sop module

---
 pgpainless-sop/README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 pgpainless-sop/README.md

diff --git a/pgpainless-sop/README.md b/pgpainless-sop/README.md
new file mode 100644
index 00000000..e690adeb
--- /dev/null
+++ b/pgpainless-sop/README.md
@@ -0,0 +1,21 @@
+# PGPainless-SOP
+
+PGPainless-SOP is an implementation of the [Stateless OpenPGP Command Line Interface](https://tools.ietf.org/html/draft-dkg-openpgp-stateless-cli-01) specification based on PGPainless.
+
+## Build
+To build an executable, `gradle jar` should be sufficient. The resulting jar file can be found in `pgpainless-sop/build/libs/`.
+
+## Execute
+You can now use the jar file like described in the stateless OpenPGP cli document.
+
+An example call may look like this:
+```
+java -jar pgpainless-sop-X.X.X.jar generate-key "Alice <alice@wonderland.lit>"
+```
+
+To discover all commands use
+```
+java -jar pgpainless-sop-X.X.X.jar help
+```
+
+Enjoy!