From 7fcb5a689830e61f3308a26c90d997e67d92f19b Mon Sep 17 00:00:00 2001 From: JKorf Date: Fri, 19 Jul 2024 09:58:41 +0200 Subject: [PATCH] Docs --- README.md | 16 +++++++++++++--- docs/index.html | 16 +++++++++++++--- 2 files changed, 26 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 70f6f73..fef22ca 100644 --- 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 index 73b18e5..4d46b11 100644 --- a/docs/index.html +++ b/docs/index.html @@ -156,7 +156,7 @@

Support the project

============================ -->

Getting Started

-

The packge is available on Nuget. After installing the package the CoinEx API is available by using the CoinExRestClient and CoinExSocketClient.

+

The package is available on Nuget. After installing the package the CoinEx API is available by using the CoinExRestClient and CoinExSocketClient.

More information and usage documentation is available at the CryptoExchange.Net documentation page
@@ -168,9 +168,19 @@

Getting Started

Installation

-

Add the package via dotnet, or add it via the package manager.

- +
Nuget
+

+
dotnet add package CoinEx.Net
+ +
GitHub packages
+

CoinEx.Net is available on GitHub packages. You'll need to add https://nuget.pkg.github.com/JKorf/index.json as a NuGet package source.

+ +
Download release
+

+ +

The NuGet package files are added along side the source with the latest GitHub release which can found here.

+