Merge pull request #204 from crisidev/async_doc

Add documentation on where to find async compatibile versions of ssh2-rs

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