summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatteo Bigoi <bigo@crisidev.org>2020-11-22 16:44:41 +0000
committerGitHub <noreply@github.com>2020-11-22 16:44:41 +0000
commit1c5bc43ace2c32f37dfc6a308d8b6d687c2dc860 (patch)
tree59d83070c5c1ae59aeb4120dfb94411806776e69
parent3872d9fae805d83f33c3ac053b6301ea65a744c3 (diff)
parent0d316d2f734a4ee03523f6001f5a1a4bb7535bc9 (diff)
downloadssh2-rs-1c5bc43ace2c32f37dfc6a308d8b6d687c2dc860.zip
Merge pull request #204 from crisidev/async_doc
Add documentation on where to find async compatibile versions of ssh2-rs
-rw-r--r--src/lib.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index f74e01e..823c24c 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -7,6 +7,10 @@
//! Note that libssh2 only supports SSH *clients*, not SSH *servers*.
//! Additionally it only supports protocol v2, not protocol v1.
//!
+//! In case you are searching for an async versions of this library,
+//! you can look at https://github.com/spebern/async-ssh2 or https://github.com/bk-rs/async-ssh2-lite,
+//! which are both adding async compatibility on top of ssh2-rs implementation.
+//!
//! # Examples
//!
//! ## Inspecting ssh-agent