summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorWez Furlong <wez@wezfurlong.org>2019-07-29 09:30:37 -0700
committerWez Furlong <wez@wezfurlong.org>2019-07-29 09:30:37 -0700
commitb631167fe0c308ca02e8269da212c436d8867a10 (patch)
treeef962115d852d04a1afdff3fae95a0816563ed2d /README.md
parenta19728e70d274eb82ad420a34fb0764aa4df298d (diff)
downloadssh2-rs-b631167fe0c308ca02e8269da212c436d8867a10.zip
tweak the readme to reflect vendored-openssl build changes
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 738d5c6..ae29cf1 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
[Documentation](https://docs.rs/ssh2)
-Rust bindings to libssh2
+Rust bindings to libssh2, an ssh client library.
## Usage
@@ -19,3 +19,7 @@ ssh2 = "0.3"
This library depends on OpenSSL. To get OpenSSL working follow the
[`openssl` crate's instructions](https://github.com/sfackler/rust-openssl#macos).
+
+Starting with version `0.4` of `ssh2`, you can enable the `vendored-openssl` feature
+to have `libssh2` built against a statically built version of openssl as [described
+here](https://docs.rs/openssl/0.10.24/openssl/#vendored)