summary refs log tree commit diff
diff options
context:
space:
mode:
authorTim M <49349513+TimothyMakkison@users.noreply.github.com>2022-11-17 12:41:13 +0000
committerPeter Dettman <peter.dettman@bouncycastle.org>2022-11-18 17:31:49 +0700
commitf965c00d4f2f50f8a833810f360a30342d3e32bd (patch)
tree8be41b014cc9d6c9475a5e954ca3ef04b0bd3652
parentfinal update for contributors file (diff)
downloadBouncyCastle.NET-ed25519-f965c00d4f2f50f8a833810f360a30342d3e32bd.tar.xz
Update README to link to the official NuGet package
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index 306cc3924..be68bee8f 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 # The Bouncy Castle Cryptography Library For .NET
+[![NuGet](https://img.shields.io/nuget/dt/BouncyCastle.Cryptography.svg)](https://www.nuget.org/packages/BouncyCastle.Cryptography) [![NuGet](https://img.shields.io/nuget/vpre/BouncyCastle.Cryptography.svg)](https://www.nuget.org/packages/BouncyCastle.Cryptography)
 
 The Bouncy Castle Cryptography library is a .NET implementation of cryptographic algorithms and protocols. It was developed by the Legion of the Bouncy Castle, a registered Australian Charity, with a little help! The Legion, and the latest goings on with this package, can be found at [https://www.bouncycastle.org](https://www.bouncycastle.org).
 
@@ -10,6 +11,18 @@ Except where otherwise stated, this software is distributed under a license base
 
 **Note**: This source tree is not the FIPS version of the APIs - if you are interested in our FIPS version please visit us [here](https://www.bouncycastle.org/fips-csharp) or contact us directly at [office@bouncycastle.org](mailto:office@bouncycastle.org).
 
+## Installing BouncyCastle
+You should install [BouncyCastle with NuGet:](https://www.nuget.org/packages/BouncyCastle.Cryptography)
+
+    Install-Package BouncyCastle.Cryptography
+
+Or via the .NET Core command line interface:
+
+    dotnet add package BouncyCastle.Cryptography
+
+Either commands, from Package Manager Console or .NET Core CLI, will download and install BouncyCastle.Cryptography.
+
+
 ## Mailing Lists
 
 For those who are interested, there are 2 mailing lists for participation in this project. To subscribe use the links below and include the word subscribe in the message body. (To unsubscribe, replace **subscribe** with **unsubscribe** in the message body)