Skip to content

Commit

Permalink
Updating README.md to highlight the tool first, then the library. (#2)
Browse files Browse the repository at this point in the history
* Updating README.md to highlight the tool first, then the library. Added links to the detail markdown for each. Added links to the dependent libraries.
  • Loading branch information
JoeBussell authored Nov 2, 2022
1 parent 3d745aa commit 99a82a1
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# CoseParser and CoseSignTool
CoseParser is a library of functions for COSE signing and validation for use by .NET applications. CoseSignTool is a platform-agnostic command line application to COSE sign files and validate COSE signatures.
# CoseSignTool and CoseParser
CoseSignTool is a platform-agnostic command line application to COSE sign files and validate COSE signatures.

CoseParser is a library of functions for COSE signing and validation for use by .NET applications.

### Requirements
CoseParser depends on System.Formats.Cbor version 7.0.0-preview.2.22115.7 and System.Security.Cryptography.Cose version 7.0.0-preview.2.22115.7 via NuGet package. Do not attempt to use later versions of either package as this will change the fundamental data structures it depends on.
CoseSignTool depends only on CoseParser and [Microsoft.Extensions.Configuration.CommandLine](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.CommandLine). It uses NuGet package version 7.0.0-preview.7.22375.6 but other versions may be compatible. See [CoseSignTool.md](https://github.com/microsoft/CoseSignTool/blob/main/CoseSignTool.md) for more details.

CoseSignTool depends only on CoseParser and Microsoft.Extensions.Configuration.CommandLine. It uses NuGet package version 7.0.0-preview.7.22375.6 but other versions may be compatible.
CoseParser depends on [System.Formats.Cbor](https://www.nuget.org/packages/System.Formats.Cbor/) version 7.0.0-preview.2.22115.7 and [System.Security.Cryptography.Cose](https://www.nuget.org/packages/System.Security.Cryptography.Cose) version 7.0.0-preview.2.22115.7 via NuGet package. Do not attempt to use later versions of either package as this will change the fundamental data structures it depends on. See [CoseParser.md](https://github.com/microsoft/CoseSignTool/blob/main/CoseParser.md) for more details.

0 comments on commit 99a82a1

Please sign in to comment.