diff options
| author | Lars Wirzenius <liw@sequoia-pgp.org> | 2022-06-08 12:11:56 +0300 |
|---|---|---|
| committer | Lars Wirzenius <liw@liw.fi> | 2022-06-10 05:00:19 +0000 |
| commit | 990d3cc525773f3464fc0dbeba210bb24de63b6a (patch) | |
| tree | 94b5fc72dc3c4025bb381d9c8f5c4677f9af322c | |
| parent | 76264a9c5a84208998f350ab30b7ef4706ce35d7 (diff) | |
sq: add README.md
Closes #129.
Sponsored-by: pep.foundation
| -rw-r--r-- | sq/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/sq/README.md b/sq/README.md new file mode 100644 index 00000000..ba52ca58 --- /dev/null +++ b/sq/README.md @@ -0,0 +1,21 @@ +# sq, the Sequoia-PGP command line tool + +[Sequoia-PGP][] is an implementation of OpenPGP in Rust. It includes a +suite of library crates, which are meant to be used from applications. +This crate provides the `sq` command line application. `sq` is aimed +at command line users as a way to use OpenPGP conveniently from the +command line. + +See the [sq user guide][] for instructions. The program also has built-in +help, using the `--help` option and `help` subcommand: + +~~~sh +$ sq help +... +~~~ + +These are collected as the [sq help][] page, for your convenience. + +[Sequoia-PGP]: https://sequoia-pgp.org/ +[sq user guide]: https://sequoia-pgp.gitlab.io/sq-user-guide/ +[sq help]: https://docs.sequoia-pgp.org/sq/index.html |