Docs, build config

JKorf · Jul 17, 2024 · 4126e0d · 4126e0d
1 parent 7784a94
commit 4126e0d
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 3 deletions.
diff --git 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/Kraken.Net/Kraken.Net.csproj b/Kraken.Net/Kraken.Net.csproj
@@ -10,7 +10,7 @@
     <PackageVersion>4.9.0</PackageVersion>
     <AssemblyVersion>4.9.0</AssemblyVersion>
     <FileVersion>4.9.0</FileVersion>
-    <Description>KrakenExchange.Net is a client library for accessing the Kraken 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>KrakenExchange.Net is a client library for accessing the Kraken 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>Kraken;KrakenExchange.Net;Kraken.Net;Kraken Client;Kraken API;CryptoCurrency;CryptoCurrency Exchange</PackageTags>
     <RepositoryType>git</RepositoryType>

diff --git a/README.md b/README.md
@@ -2,7 +2,16 @@
 
 [![.NET](https://img.shields.io/github/actions/workflow/status/JKorf/Kraken.Net/dotnet.yml?style=for-the-badge)](https://github.com/JKorf/Kraken.Net/actions/workflows/dotnet.yml) ![License](https://img.shields.io/github/license/JKorf/Kraken.Net?style=for-the-badge)
 
-Kraken.Net is a strongly typed client library for accessing the [Kraken REST and Websocket API](https://www.kraken.com/features/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.
+Kraken.Net is a strongly typed client library for accessing the [Kraken REST and Websocket API](https://www.kraken.com/features/api).
+## 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
+* 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
@@ -98,7 +98,19 @@
         <section id="idocs_intro">
 			<h1>Kraken.Net</h1>
 
-		<p>Kraken.Net is a strongly typed client library for accessing the <a href="https://www.kraken.com/features/api" target="_blank">Kraken 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>Kraken.Net is a strongly typed client library for accessing the <a href="https://www.kraken.com/features/api" target="_blank">Kraken 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</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>