add feature to vendor openssl

Closes malept#17
tshepang · Jun 6, 2020 · f52f5f7 · f52f5f7
1 parent 41765b4
commit f52f5f7
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/Cargo.toml b/Cargo.toml
@@ -27,4 +27,7 @@ commoncrypto = "0.2"
 winapi = { version = "0.3", features = ["minwindef", "wincrypt"] }
 
 [target.'cfg(not(any(target_os = "windows", target_os = "macos", target_os = "ios")))'.dependencies]
-openssl = "0.10"
+openssl = { version = "0.10", optional = true }
+
+[features]
+vendored-openssl = ["openssl/vendored"]
diff --git a/README.md b/README.md
@@ -40,6 +40,15 @@ let digest = hex_digest(Algorithm::SHA256, b"crypto-hash");
 
 For more examples, consult the [documentation](https://malept.github.io/crypto-hash/).
 
+To help create portable executables, there is a feature to build a
+vendored openssl, named `vendored-openssl`:
+
+```toml
+[dependencies.crypto-hash]
+features = ["vendored-openssl"]
+...
+```
+
 ## [Release Notes](https://github.com/malept/crypto-hash/blob/master/NEWS.md)
 
 ## [Contributing](https://github.com/malept/crypto-hash/blob/master/CONTRIBUTING.md)