summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWiktor Kwapisiewicz <wiktor@metacode.biz>2023-02-13 13:37:44 +0100
committerWiktor Kwapisiewicz <wiktor@metacode.biz>2023-02-13 13:37:44 +0100
commit852a4f79df24ede1cd6b2410f7d51a7bc82b673c (patch)
tree5a3550bb48f78154eb0f7ded2ca4636fb895ba7a
parentb43a3408812ef453afc677d243f7aff51715e121 (diff)
doc: Suggest using `default` feature of `sequoia_openpgp`.
- Suggesting using the default feature allows `sequoia_openpgp` to change the default and the other crates will adjust. - This also fixes the `sequoia` typo in the crate name. - Related MR: https://gitlab.com/openpgp-card/openpgp-card/-/merge_requests/35
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7be89541..5baa4ac5 100644
--- a/README.md
+++ b/README.md
@@ -134,12 +134,15 @@ Like so:
# Cargo.toml
[dependencies]
sequoia-openpgp = { version = "*", default-features = false }
+
[features]
# Pick a Sequoia backend enabled by default
-default = ["seqouia-openpgp/crypto-nettle"]
+default = ["sequoia-openpgp/default"]
+
# .. but allow others to select a different backend, as well
crypto-cng = ["sequoia-openpgp/crypto-cng"]
crypto-nettle = ["sequoia-openpgp/crypto-nettle"]
+# .. other backends
```
Once Cargo target-specific default features are [implemented], it will