Skip to content

Commit c17a565

Browse files
authored
doc: Update README with usage/ installation instructions (#282)
1 parent da217b4 commit c17a565

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
1-
# AWS Encryption SDK Dafny
1+
# AWS Encryption SDK Written in Dafny
22

33
![Build Status - master branch](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiVmIzeGwwQmY5bXdMQXg2aVBneWtDc3FHSWRHTjYrNnVUem9nNXJFUmY2Rk1yRnJvSjJvK3JCL2RScFRjSVF1UjA1elR3L0xpTVpiNmRZS0RyWjJpTnBFPSIsIml2UGFyYW1ldGVyU3BlYyI6InBBQm1tT1BPNjB3RU9XUS8iLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)
44

5-
AWS Encryption SDK for Dafny
5+
AWS Encryption SDK Written in Dafny for .NET
66

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
818

919
To build, the AWS Encryption SDK requires the most up to date version of [dafny](https://github.com/dafny-lang/dafny) on your PATH.
1020

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).
1224

1325
To build all source files into one dll:
1426

@@ -23,7 +35,7 @@ To run the dafny verifier across all files:
2335
dotnet build -t:VerifyDafny test
2436
```
2537

26-
## Testing
38+
## Testing the AWS Encryption SDK Written in Dafny
2739

2840
Run the test suite with:
2941

0 commit comments

Comments
 (0)