foreword.md 941 B
# Foreword
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 page. Please note that you will need to right-click and "unblock" 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 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. 🤓