aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Crichton <[email protected]>2018-07-31 07:31:56 -0700
committerGitHub <[email protected]>2018-07-31 07:31:56 -0700
commit09ce91655140d272e19e443d0eb4fe0d02268588 (patch)
tree608db122754dc62b1a569b864f1f1fc80eb59969
parentMerge pull request #963 from alexcrichton/vendored (diff)
parentAdd some docs to the README about the vendored feature. (diff)
downloadrust-openssl-09ce91655140d272e19e443d0eb4fe0d02268588.tar.xz
rust-openssl-09ce91655140d272e19e443d0eb4fe0d02268588.zip
Merge pull request #967 from sfackler/vendored-docs
Add some docs to the README about the vendored feature.
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 16155fbd..5ca291e1 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,21 @@ libraries and headers need to be present in the build environment before this
crate is compiled, and some instructions of how to do this are in the sections
below.
+### Vendored
+
+```toml
+[dependencies]
+openssl = { version = "0.10", features = ["vendored"] }
+```
+
+If the `vendored` Cargo feature is enabled, the `openssl-src` crate will be used
+to compile OpenSSL from source and statically link to it. OpenSSL version 1.1.0
+is currently used, but that will be upgraded to 1.1.1 at some point after it is
+released *without* a major version bump to this crate.
+
+This vendored copy will not be configured to automatically find the system's
+root certificates, but the `openssl-probe` crate can be used to do that instead.
+
### Linux
On Linux, you can typically install OpenSSL via your package manager. The