Docs

JKorf · Jul 19, 2024 · 7fcb5a6 · 7fcb5a6
1 parent 3335b6d
commit 7fcb5a6
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -26,10 +26,20 @@ The library is targeting both `.NET Standard 2.0` and `.NET Standard 2.1` for op
 |UWP|`10.0.16299` and higher|
 |Unity|`2018.1` and higher|
 
-## Get the library
-[![Nuget version](https://img.shields.io/nuget/v/CoinEx.net.svg?style=for-the-badge)](https://www.nuget.org/packages/CoinEx.Net)  [![Nuget downloads](https://img.shields.io/nuget/dt/CoinEx.Net.svg?style=for-the-badge)](https://www.nuget.org/packages/CoinEx.Net)
-
+## Install the library
+
+### NuGet 
+[![NuGet version](https://img.shields.io/nuget/v/CoinEx.net.svg?style=for-the-badge)](https://www.nuget.org/packages/CoinEx.Net)  [![Nuget downloads](https://img.shields.io/nuget/dt/CoinEx.Net.svg?style=for-the-badge)](https://www.nuget.org/packages/CoinEx.Net)
+
 	dotnet add package CoinEx.Net
+
+### GitHub packages
+CoinEx.Net is available on [GitHub packages](https://github.com/JKorf/CoinEx.Net/pkgs/nuget/CoinEx.Net). You'll need to add `https://nuget.pkg.github.com/JKorf/index.json` as a NuGet package source.
+
+### Download release
+[![GitHub Release](https://img.shields.io/github/v/release/JKorf/CoinEx.Net?style=for-the-badge&label=GitHub)](https://github.com/JKorf/CoinEx.Net/releases)
+
+The NuGet package files are added along side the source with the latest GitHub release which can found [here](https://github.com/JKorf/CoinEx.Net/releases).
 
 ## How to use
 *REST Endpoints*  

diff --git a/docs/index.html b/docs/index.html
@@ -156,7 +156,7 @@ <h4>Support the project</h4>
 		============================ -->
         <section id="idocs_start">
         <h1>Getting Started</h1>
-		<p>The packge is available on Nuget. After installing the package the CoinEx API is available by using the <code>CoinExRestClient</code> and <code>CoinExSocketClient</code>.</p>
+		<p>The package is available on Nuget. After installing the package the CoinEx API is available by using the <code>CoinExRestClient</code> and <code>CoinExSocketClient</code>.</p>
 		<div class="alert alert-info">More information and usage documentation is available at the <a href="https://jkorf.github.io/CryptoExchange.Net/" target="_blank">CryptoExchange.Net</a> documentation page</div>
 
         </section>
@@ -168,9 +168,19 @@ <h1>Getting Started</h1>
         <section id="idocs_installation">
           <h2>Installation</h2>
 
-		  <p>Add the package via dotnet, or add it via the package manager.</p>
-
+		  <h5>Nuget</h5>
+		  <p><a href="https://www.nuget.org/packages/CoinEx.Net"><img src="https://img.shields.io/nuget/v/CoinEx.net.svg?style=for-the-badge" /></a> <a href="https://www.nuget.org/packages/CoinEx.Net"><img src="https://img.shields.io/nuget/dt/CoinEx.Net.svg?style=for-the-badge" /></a></p>
+
 		  <pre><code>dotnet add package CoinEx.Net</code></pre>
+
+		  <h5>GitHub packages</h5>
+		  <p>CoinEx.Net is available on <a href="https://github.com/JKorf/CoinEx.Net/pkgs/nuget/CoinEx.Net">GitHub packages</a>. You'll need to add <code>https://nuget.pkg.github.com/JKorf/index.json</code> as a NuGet package source.</p>
+
+		  <h5>Download release</h5>
+		  <p><a href="https://github.com/JKorf/CoinEx.Net/releases"><img src="https://img.shields.io/github/v/release/JKorf/CoinEx.Net?style=for-the-badge&label=GitHub" /></a></p>
+
+		  <p>The NuGet package files are added along side the source with the latest GitHub release which can found <a href="https://github.com/JKorf/CoinEx.Net/releases">here</a>.</p>
+
         </section>
 
 		<hr class="divider">