From 3335b6de6c3c1db7c74968fa75a697f1cbbfc3f7 Mon Sep 17 00:00:00 2001 From: JKorf Date: Wed, 17 Jul 2024 14:04:12 +0200 Subject: [PATCH] Docs, build config --- .github/workflows/dotnet.yml | 2 ++ CoinEx.Net/CoinEx.Net.csproj | 2 +- README.md | 11 ++++++++++- docs/index.html | 14 +++++++++++++- 4 files changed, 26 insertions(+), 3 deletions(-) diff --git a/.github/workflows/dotnet.yml b/.github/workflows/dotnet.yml index cbe35f5..9db0dbe 100644 --- a/.github/workflows/dotnet.yml +++ b/.github/workflows/dotnet.yml @@ -17,6 +17,8 @@ jobs: uses: actions/setup-dotnet@v1 with: dotnet-version: 6.0.x + - name: Set GitHub package source + run: dotnet nuget add source --username JKorf --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text --name github "https://nuget.pkg.github.com/JKorf/index.json" - name: Restore dependencies run: dotnet restore - name: Build diff --git a/CoinEx.Net/CoinEx.Net.csproj b/CoinEx.Net/CoinEx.Net.csproj index 4eab4ff..1d7162c 100644 --- a/CoinEx.Net/CoinEx.Net.csproj +++ b/CoinEx.Net/CoinEx.Net.csproj @@ -10,7 +10,7 @@ 7.3.0 7.3.0 7.3.0 - CoinEx.Net is a client library for accessing the CoinEx REST and Websocket API. All data is mapped to readable models and enum values. Additional features include an implementation for maintaining a client side order book, easy integration with other exchange client libraries and more. + CoinEx.Net is a client library for accessing the CoinEx REST and Websocket API. All data is mapped to readable models and enum values. Additional features include automatic websocket (re)connection management, an implementation for maintaining a client side order book, easy integration with other exchange client libraries and more. false CoinEx;CoinEx.Net;CoinEx Client;CoinEx API;CryptoCurrency;CryptoCurrency Exchange git diff --git a/README.md b/README.md index b19cfd9..70f6f73 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,16 @@ [![.NET](https://img.shields.io/github/actions/workflow/status/JKorf/CoinEx.Net/dotnet.yml?style=for-the-badge)](https://github.com/JKorf/CoinEx.Net/actions/workflows/dotnet.yml) ![License](https://img.shields.io/github/license/JKorf/CoinEx.Net?style=for-the-badge) -CoinEx.Net is a strongly typed client library for accessing the [CoinEx REST and Websocket API](https://github.com/coinexcom/coinex_exchange_api/wiki). All data is mapped to readable models and enum values. Additional features include an implementation for maintaining a client side order book, easy integration with other exchange client libraries and more. +CoinEx.Net is a strongly typed client library for accessing the [CoinEx REST and Websocket API](https://github.com/coinexcom/coinex_exchange_api/wiki). + +## Features +* Response data is mapped to descriptive models +* Input parameters and response values are mapped to discriptive enum values where possible +* Automatic websocket (re)connection management +* Cient side order book implementation +* Extensive logging +* Support for different environments +* Easy integration with other exchange client based on the CryptoExchange.Net base library ## Supported Frameworks The library is targeting both `.NET Standard 2.0` and `.NET Standard 2.1` for optimal compatibility diff --git a/docs/index.html b/docs/index.html index a04085d..73b18e5 100644 --- a/docs/index.html +++ b/docs/index.html @@ -97,7 +97,19 @@

CoinEx.Net

-

CoinEx.Net is a strongly typed client library for accessing the CoinEx REST and Websocket API. All data is mapped to readable models and enum values. Additional features include an implementation for maintaining a client side order book, easy integration with other exchange client libraries and more.

+

CoinEx.Net is a strongly typed client library for accessing the CoinEx REST and Websocket API.

+ +

Features

+ +
This library is based on the CryptoExchange.Net base package and can be used in combination with other exchange packages!

Supported Frameworks