summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJustus Winter <justus@sequoia-pgp.org>2021-11-18 15:41:43 +0100
committerJustus Winter <justus@sequoia-pgp.org>2021-11-18 15:43:06 +0100
commit665efe714ecfd8a7b40316fa45760f665bae526f (patch)
tree96b4612dca5bc92d47492b7d90ee37ab9b46d362
parent9a3e872439d87f745e6a8b9fcc6d6a2f87d3c3be (diff)
openpgp: Hint at WASM support in the README.md.
- Fixes #570.
-rw-r--r--openpgp/NEWS3
-rw-r--r--openpgp/README.md16
2 files changed, 19 insertions, 0 deletions
diff --git a/openpgp/NEWS b/openpgp/NEWS
index d0b727ac..2142aeff 100644
--- a/openpgp/NEWS
+++ b/openpgp/NEWS
@@ -2,6 +2,9 @@
#+TITLE: sequoia-openpgp NEWS – history of user-visible changes
#+STARTUP: content hidestars
+* Changes in 1.7.0
+** Notable fixes
+ - sequoia-openpgp can now be compiled to WASM.
* Changes in 1.6.0
** Notable fixes
- Decryption of encrypted messages and verification of
diff --git a/openpgp/README.md b/openpgp/README.md
index c4bfa9e8..dc2a10cc 100644
--- a/openpgp/README.md
+++ b/openpgp/README.md
@@ -106,6 +106,22 @@ algorithms, `compression-deflate` to enable *DEFLATE* and *zlib*
compression support, and `compression-bzip2` to enable *bzip2*
support.
+# Compiling to WASM
+
+With the right feature flags, Sequoia can be compiled to WASM. To do
+that, enable the RustCrypto backend, and make sure not to enable
+*bzip2* compression support:
+
+```toml
+sequoia-openpgp = { version = "*", default-features = false, features = ["crypto-rust", "allow-experimental-crypto", "allow-variable-time-crypto"] }
+```
+
+Or, with `compression-deflate` support:
+
+```toml
+sequoia-openpgp = { version = "*", default-features = false, features = ["crypto-rust", "allow-experimental-crypto", "allow-variable-time-crypto", "compression-deflate"] }
+```
+
# Minimum Supported Rust Version (MSRV)
`sequoia-openpgp` requires Rust 1.48.