Documentation updates (#1395)

- Update README to point to https://sshnet.github.io/SSH.NET rather than the CHM file
- Add a CONTRIBUTING.md with some how-tos

For https://sshnet.github.io/SSH.NET:

- Use the repo README as the landing page to keep them in sync
- Combine the API-per-TFM pages to just one "API" page
- Add a couple more examples
- Add a GitHub link in the header.
This commit is contained in:
Rob Hague
2024-05-10 10:38:47 +01:00
committed by GitHub
parent 0cfeb6bb94
commit 1de33c469e
13 changed files with 181 additions and 302 deletions
+3 -2
View File
@@ -19,7 +19,7 @@ namespace Renci.SshNet
public int KeySize { get; private set; }
/// <summary>
/// Gets a value indicating whether enable encrypt-then-MAC or use encrypt-and-MAC.
/// Gets a value indicating whether the MAC algorithm will use encrypt-then-MAC ordering.
/// </summary>
/// <value>
/// <see langword="true"/> to enable encrypt-then-MAC, <see langword="false"/> to use encrypt-and-MAC.
@@ -27,7 +27,8 @@ namespace Renci.SshNet
public bool IsEncryptThenMAC { get; private set; }
/// <summary>
/// Gets the cipher.
/// Gets the method for creating a <see cref="System.Security.Cryptography.HashAlgorithm"/> instance
/// given a key.
/// </summary>
public Func<byte[], HashAlgorithm> HashAlgorithm { get; private set; }