Skip to content

Commit 5948898

Browse files
committed
Add some docs to the README about the vendored feature.
1 parent aba2969 commit 5948898

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,21 @@ libraries and headers need to be present in the build environment before this
1717
crate is compiled, and some instructions of how to do this are in the sections
1818
below.
1919

20+
### Vendored
21+
22+
```toml
23+
[dependencies]
24+
openssl = { version = "0.10", features = ["vendored"] }
25+
```
26+
27+
If the `vendored` Cargo feature is enabled, the `openssl-src` crate will be used
28+
to compile OpenSSL from source and statically link to it. OpenSSL version 1.1.0
29+
is currently used, but that will be upgraded to 1.1.1 at some point after it is
30+
released *without* a major version bump to this crate.
31+
32+
This vendored copy will not be configured to automatically find the system's
33+
root certificates, but the `openssl-probe` crate can be used to do that instead.
34+
2035
### Linux
2136

2237
On Linux, you can typically install OpenSSL via your package manager. The

0 commit comments

Comments
 (0)