From 1e2aed8557acb31a59206a36160cfccec303c6e3 Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Thu, 3 Feb 2022 15:43:33 +0100 Subject: [PATCH] Update READMEs --- pgp-cert-d-java/README.md | 8 ++++++++ pgpainless-cert-d-cli/README.md | 10 ++++++++++ pgpainless-cert-d/README.md | 2 ++ 3 files changed, 20 insertions(+) create mode 100644 pgpainless-cert-d-cli/README.md diff --git a/pgp-cert-d-java/README.md b/pgp-cert-d-java/README.md index 945eecc0..cb289582 100644 --- a/pgp-cert-d-java/README.md +++ b/pgp-cert-d-java/README.md @@ -6,3 +6,11 @@ SPDX-License-Identifier: Apache-2.0 # Shared PGP Certificate Directory for Java +Backend-agnostic implementation of the [Shared PGP Certificate Directory Specification](https://sequoia-pgp.gitlab.io/pgp-cert-d/). +This module implements the non-OpenPGP parts of the spec, e.g. locating the directory, resolving certificate file paths, +locking the directory for writes etc. + +To get a useful implementation, a backend implementation such as `pgpainless-cert-d` is required, which needs to provide +support for reading and merging certificates. + +`pgp-cert-d-java` can be used as an implementation of `pgp-certificate-store`. \ No newline at end of file diff --git a/pgpainless-cert-d-cli/README.md b/pgpainless-cert-d-cli/README.md new file mode 100644 index 00000000..86735bbe --- /dev/null +++ b/pgpainless-cert-d-cli/README.md @@ -0,0 +1,10 @@ + + +# Command Line Interface for pgpainless-cert-d + +This module utilizes [picocli](https://picocli.info) to provide a CLI application for use with the +[Shared PGP Certificate Directory](https://sequoia-pgp.gitlab.io/pgp-cert-d/). diff --git a/pgpainless-cert-d/README.md b/pgpainless-cert-d/README.md index 0cc5f15c..a170a029 100644 --- a/pgpainless-cert-d/README.md +++ b/pgpainless-cert-d/README.md @@ -5,3 +5,5 @@ SPDX-License-Identifier: Apache-2.0 --> # Certificate Stores + PGPainless + +This module makes use of `pgpainless-core` to provide backend implementations of classes required by `pgp-cert-d-java`. \ No newline at end of file