Add README for sop module

This commit is contained in:
Paul Schaub 2021-01-03 17:45:05 +01:00
parent f5338e13e7
commit 9333fa2b65
Signed by: vanitasvitae
GPG Key ID: 62BEE9264BF17311
1 changed files with 21 additions and 0 deletions

21
pgpainless-sop/README.md Normal file
View File

@ -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!