Skip to content

Commit

Permalink
Merge pull request sfackler#967 from sfackler/vendored-docs
Browse files Browse the repository at this point in the history
Add some docs to the README about the vendored feature.
  • Loading branch information
alexcrichton authored Jul 31, 2018
2 parents aba2969 + 5948898 commit 09ce916
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 09ce916

Please sign in to comment.