Skip to content

Commit 08c0447

Browse files
authored
Update README.md
1 parent 0a996b1 commit 08c0447

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,16 @@ SPDX-License-Identifier: MIT
2121

2222
The implementation is for AnyCPU, and works on all platforms.
2323

24-
API documentation will follow, but here is a sneak preview:
24+
# Usage
25+
26+
The released binary NuGet packages and the .NET assemblies contained therein:
27+
28+
- use [Strong Naming](https://docs.microsoft.com/en-us/dotnet/standard/library-guidance/strong-naming),
29+
- include [SourceLink](https://docs.microsoft.com/en-us/dotnet/standard/library-guidance/sourcelink),
30+
- include [IntelliSense](https://docs.microsoft.com/en-us/visualstudio/ide/using-intellisense) compatible documentation, and
31+
- are signed and timestamped with Authenticode.
32+
33+
All public classes are in the `Dorssel.Security.Cryptography` namespace.
2534

2635
- `AesCtr` is modeled after .NET's `Aes`. So, instead of `Aes.Create()`, use `AesCtr.Create()`.
2736
- `AesCmac` is modeled after .NET's `HMACSHA256`. So, instead of `new HMACSHA256(key)`, use `new AesCmac(key)`.

0 commit comments

Comments
 (0)