PGPainless/pgpeasy
1
0
Fork 0
mirror of https://codeberg.org/PGPainless/pgpeasy.git synced 2024-12-04 13:22:08 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update README

Browse source
This commit is contained in:
Paul Schaub 2022-05-15 17:00:56 +02:00
parent c5df59f68c
commit f960521aab
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -8,10 +8,13 @@ SPDX-License-Identifier: Apache-2.0
PGPeasy is intended to become your next OpenPGP multi-tool. PGPeasy is intended to become your next OpenPGP multi-tool.
It provides an easy interface for all sorts of operations, such as generating and discovering keys, encrypting and decrypting messages, managing certificates... It provides an easy interface for all sorts of operations, such as generating and discovering keys, encrypting and decrypting messages, managing certificates...
## Why another CLI?
Contrary to `pgpainless-cli`, this application is not limited to the SOP specification, so it is possible to extend it with additional behavior and more powerful features. Contrary to `pgpainless-cli`, this application is not limited to the SOP specification, so it is possible to extend it with additional behavior and more powerful features.
A good example for a feature that will get added at some point is support for password protected keys. A good example for a feature that will get added at some point is support for password protected keys.
## Usage
The application aims to be pretty self-explanatory. If you are not about a certain subcommand, just execute `pgpeasy help <subcommand>`.
```shell ```shell
$ pgpeasy help $ pgpeasy help
Usage: pgpeasy [COMMAND] Usage: pgpeasy [COMMAND]
@ -35,10 +38,9 @@ Commands:
wot Interact with the Web of Trust wot Interact with the Web of Trust
help Displays help information about the help Displays help information about the
specified command specified command
``` ```
## Building Instructions ## Build Instructions
Clone the repository and execute `gradle build` in the project directory. Clone the repository and execute `gradle build` in the project directory.
Afterwards you can find archives containing the application in the `build/distributions/` directory. Afterwards you can find archives containing the application in the `build/distributions/` directory.