Minor edit of README

This commit is contained in:
Heiko Schaefer 2021-08-18 20:10:48 +02:00
parent b8e3fc4816
commit a35ba66784

View file

@ -3,18 +3,19 @@ SPDX-FileCopyrightText: 2021 Heiko Schaefer <heiko@schaefer.name>
SPDX-License-Identifier: MIT OR Apache-2.0
-->
**OpenPGP card for Sequoia PGP**
**OpenPGP card usage with Sequoia PGP**
This crate is a thin wrapper for the
This crate is a higher level wrapper for the
[openpgp-card](https://crates.io/crates/openpgp-card) crate.
It offers convenient access to
[OpenPGP card](https://en.wikipedia.org/wiki/OpenPGP_card)
functionality with [Sequoia PGP](https://sequoia-pgp.org/).
functionality using [Sequoia PGP](https://sequoia-pgp.org/).
**Example code**
The program `main.rs` performs a number of functions on an OpenPGP card.
To use it, you need to set an environment variable to the serial number of
To run it, you need to set an environment variable to the identifier of
the OpenPGP card you want to use.
NOTE: data on this card will be deleted in the process of running this
@ -25,8 +26,7 @@ $ export TEST_CARD_IDENT="0123:4567ABCD"
$ cargo run
```
You can see a lot more debugging output by increasing the log-level,
like this:
You can see more debugging output by increasing the log-level, like this:
```
$ RUST_LOG=trace cargo run