Skip to content

Commit

Permalink
Docs, build config
Browse files Browse the repository at this point in the history
  • Loading branch information
JKorf committed Jul 17, 2024
1 parent bdfed3b commit 91e90ec
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/dotnet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Kucoin.Net/Kucoin.Net.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<PackageVersion>5.9.0</PackageVersion>
<AssemblyVersion>5.9.0</AssemblyVersion>
<FileVersion>5.9.0</FileVersion>
<Description>Kucoin.Net is a client library for accessing the Kucoin 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.</Description>
<Description>Kucoin.Net is a client library for accessing the Kucoin REST and Websocket API. All data is mapped to readable models and enum values. Additional features include automatic websocket (re)connection management, client side rate limiting, an implementation for maintaining a client side order book, easy integration with other exchange client libraries and more.</Description>
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
<PackageTags>Kucoin;Kucoin.Net;Kucoin Client;Kucoin API;CryptoCurrency;CryptoCurrency Exchange</PackageTags>
<RepositoryType>git</RepositoryType>
Expand Down
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,16 @@

[![.NET](https://img.shields.io/github/actions/workflow/status/JKorf/Kucoin.Net/dotnet.yml?style=for-the-badge)](https://github.com/JKorf/Kucoin.Net/actions/workflows/dotnet.yml) ![License](https://img.shields.io/github/license/JKorf/Kucoin.Net?style=for-the-badge)

Kucoin.Net is a strongly typed client library for accessing the [Kucoin REST and Websocket API](https://www.kucoin.com/docs/beginners/introduction). 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.
Kucoin.Net is a strongly typed client library for accessing the [Kucoin REST and Websocket API](https://www.kucoin.com/docs/beginners/introduction).
## 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
* Client side rate limiting
* Cient side order book implementation
* Extensive logging
* Support for different environments (production, testnet)
* 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
Expand Down
13 changes: 12 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,18 @@
<section id="idocs_intro">
<h1>Kucoin.Net</h1>

<p>Kucoin.Net is a strongly typed client library for accessing the <a href="https://docs.kucoin.com/" target="_blank">Kucoin REST and Websocket API</a>. 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.</p>
<p>Kucoin.Net is a strongly typed client library for accessing the <a href="https://docs.kucoin.com/" target="_blank">Kucoin REST and Websocket API</a>.</p>
<h4>Features</h4>
<ul>
<li>Response data is mapped to descriptive models</li>
<li>Input parameters and response values are mapped to discriptive enum values where possible</li>
<li>Automatic websocket (re)connection management </li>
<li>Client side rate limiting </li>
<li>Cient side order book implementation</li>
<li>Extensive logging</li>
<li>Support for different environments (production, testnet)</li>
<li>Easy integration with other exchange client based on the CryptoExchange.Net base library</li>
</ul>
<div class="alert alert-info">This library is based on the <a href="https://jkorf.github.io/CryptoExchange.Net/" target="_blank">CryptoExchange.Net</a> base package and can be used in combination with other exchange packages!</div>

<h4>Supported Frameworks</h4>
Expand Down

0 comments on commit 91e90ec

Please sign in to comment.