Skip to content

Commit f262b4a

Browse files
authored
Added documentation section to README (#656)
1 parent 2c1a4d9 commit f262b4a

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
SSH.NET
1+
SSH.NET
22
=======
33
SSH.NET is a Secure Shell (SSH-2) library for .NET, optimized for parallelism.
44

@@ -7,7 +7,23 @@ SSH.NET is a Secure Shell (SSH-2) library for .NET, optimized for parallelism.
77
[![Build status](https://ci.appveyor.com/api/projects/status/ih77qu6tap3o92gu/branch/develop?svg=true)](https://ci.appveyor.com/api/projects/status/ih77qu6tap3o92gu/branch/develop)
88

99
## Introduction
10-
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.
10+
This project was inspired by **Sharp.SSH** library which was ported from java and it seems like was not supported
11+
for quite some time. This library is a complete rewrite, without any third party dependencies, using parallelism
12+
to achieve the best performance possible.
13+
14+
## Documentation
15+
There is MSDN-style class documentation in a .chm file for each release, which you can find in the Assets section
16+
of the [latest release](https://github.com/sshnet/SSH.NET/releases/latest) page. Please note that you will need
17+
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)
18+
the CHM file after you download it.
19+
20+
Currently (4/18/2020), the documentation is very sparse. Fortunately, there are a large number of tests in
21+
[Renci.SshNet.Tests](https://github.com/sshnet/SSH.NET/tree/develop/src/Renci.SshNet.Tests) that demonstrate
22+
usage with working code.
23+
24+
If the test for the functionality you would like to see documented is not complete, then you are cordially
25+
invited to read the source, Luke, and highly encouraged to generate a pull request for the implementation of
26+
the missing test once you figure things out. 🤓
1127

1228
## Features
1329
* Execution of SSH command using both synchronous and asynchronous methods

0 commit comments

Comments
 (0)