You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+17-5
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,26 @@
1
-
# AWS Encryption SDK Dafny
1
+
# AWS Encryption SDK Written in Dafny
2
2
3
3

4
4
5
-
AWS Encryption SDK for Dafny
5
+
AWS Encryption SDK Written in Dafny for .NET
6
6
7
-
## Building
7
+
## Using the AWS Encryption SDK for .NET
8
+
The AWS Encryption SDK is available on [NuGet](https://www.nuget.org/) and can referenced from an existing `.csproj` through typical ways.
9
+
10
+
```
11
+
<!-- TODO: Update with actual NuGet package name, the name below is just an example -->
12
+
<PackageReference Include="AWS.EncryptionSDK" />
13
+
```
14
+
15
+
The Encryption SDK source has a target framework of [netstandard2.0](https://docs.microsoft.com/en-us/dotnet/standard/net-standard).
16
+
17
+
## Building the AWS Encryption SDK Written in Dafny
8
18
9
19
To build, the AWS Encryption SDK requires the most up to date version of [dafny](https://github.com/dafny-lang/dafny) on your PATH.
10
20
11
-
Building and verifying also requires [dotnet 3.0](https://dotnet.microsoft.com/download/dotnet-core/3.0).
21
+
The Encryption SDK source has a target framework of [netstandard2.0](https://docs.microsoft.com/en-us/dotnet/standard/net-standard).
22
+
Tests and test vectors have a target framework of [netcoreapp3.0](https://docs.microsoft.com/en-us/dotnet/standard/frameworks), which is required for properly building and running tests.
23
+
Therefore, building and verifying requires [dotnet 3.0](https://dotnet.microsoft.com/download/dotnet-core/3.0).
12
24
13
25
To build all source files into one dll:
14
26
@@ -23,7 +35,7 @@ To run the dafny verifier across all files:
23
35
dotnet build -t:VerifyDafny test
24
36
```
25
37
26
-
## Testing
38
+
## Testing the AWS Encryption SDK Written in Dafny
0 commit comments