diff --git a/README.md b/README.md index 9d09c9f4..db4d3f7a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -SSH.NET +SSH.NET ======= SSH.NET is a Secure Shell (SSH-2) library for .NET, optimized for parallelism. @@ -7,7 +7,23 @@ SSH.NET is a Secure Shell (SSH-2) library for .NET, optimized for parallelism. [![Build status](https://ci.appveyor.com/api/projects/status/ih77qu6tap3o92gu/branch/develop?svg=true)](https://ci.appveyor.com/api/projects/status/ih77qu6tap3o92gu/branch/develop) ## Introduction -This project was inspired by **Sharp.SSH** library which was ported from java and it seems like was not supported for quite some time. This library is a complete rewrite, without any third party dependencies, using parallelism to achieve the best performance possible. +This project was inspired by **Sharp.SSH** library which was ported from java and it seems like was not supported +for quite some time. This library is a complete rewrite, without any third party dependencies, using parallelism +to achieve the best performance possible. + +## Documentation +There is MSDN-style class documentation in a .chm file for each release, which you can find in the Assets section +of the [latest release](https://github.com/sshnet/SSH.NET/releases/latest) page. Please note that you will need +to [right-click and "unblock"](https://support.microsoft.com/en-us/help/2021383/some-chm-files-may-not-render-properly-on-windows-vista-and-windows-7) +the CHM file after you download it. + +Currently (4/18/2020), the documentation is very sparse. Fortunately, there are a large number of tests in +[Renci.SshNet.Tests](https://github.com/sshnet/SSH.NET/tree/develop/src/Renci.SshNet.Tests) that demonstrate +usage with working code. + +If the test for the functionality you would like to see documented is not complete, then you are cordially +invited to read the source, Luke, and highly encouraged to generate a pull request for the implementation of +the missing test once you figure things out. 🤓 ## Features * Execution of SSH command using both synchronous and asynchronous methods