From b9e881db13513d2c0141d3f8670f25eb756f6cc8 Mon Sep 17 00:00:00 2001 From: JKorf Date: Fri, 19 Jul 2024 09:58:23 +0200 Subject: [PATCH] Docs --- README.md | 14 ++++++++++++-- docs/index.html | 16 +++++++++++++--- 2 files changed, 25 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6690490f..e800b331 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,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/Huobi.net.svg?style=for-the-badge)](https://www.nuget.org/packages/Huobi.Net) [![Nuget downloads](https://img.shields.io/nuget/dt/Huobi.Net.svg?style=for-the-badge)](https://www.nuget.org/packages/Huobi.Net) +## Install the library + +### NuGet +[![NuGet version](https://img.shields.io/nuget/v/Huobi.net.svg?style=for-the-badge)](https://www.nuget.org/packages/Huobi.Net) [![Nuget downloads](https://img.shields.io/nuget/dt/Huobi.Net.svg?style=for-the-badge)](https://www.nuget.org/packages/Huobi.Net) dotnet add package Huobi.Net + +### GitHub packages +Huobi.Net is available on [GitHub packages](https://github.com/JKorf/Huobi.Net/pkgs/nuget/Huobi.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/Huobi.Net?style=for-the-badge&label=GitHub)](https://github.com/JKorf/Huobi.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/Huobi.Net/releases). ## How to use *REST Endpoints* diff --git a/docs/index.html b/docs/index.html index 53616e14..f016d607 100644 --- a/docs/index.html +++ b/docs/index.html @@ -155,7 +155,7 @@

Support the project

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

Getting Started

-

The packge is available on Nuget. After installing the package the Huobi API is available by using the HuobiRestClient and HuobiSocketClient.

+

The package is available on Nuget. After installing the package the Huobi API is available by using the HuobiRestClient and HuobiSocketClient.

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

Getting Started

Installation

-

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

- +
Nuget
+

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

Huobi.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.

+