Skip to content

Commit

Permalink
Updated version info and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JKorf committed Feb 25, 2024
1 parent daa1e89 commit 453b8e7
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 13 deletions.
8 changes: 4 additions & 4 deletions OKX.Net/OKX.Net.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@
<PropertyGroup>
<PackageId>JK.OKX.Net</PackageId>
<Authors>JKorf</Authors>
<PackageVersion>1.6.0-beta3</PackageVersion>
<PackageVersion>1.6.0</PackageVersion>
<FileVersion>1.6.0</FileVersion>
<AssemblyVersion>1.6.0</AssemblyVersion>
<Description>OKX.Net is a .Net wrapper for the OKX API (https://www.okx.com). It includes all features the API provides, REST API and Websocket, using clear and readable objects including but not limited to Reading market info, Placing and managing orders and Reading balances and funds</Description>
<Description>JK.OKX.Net is client library for accessing the OKX 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>
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
<PackageTags>OKX OKEx OKEx.Net C# .Net CryptoCurrency Exchange Rest API and WebSocket API Wrapper</PackageTags>
<PackageTags>OKX;OKX.Net;OKX Client;OKX API;CryptoCurrency;CryptoCurrency Exchange</PackageTags>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageIcon>icon.png</PackageIcon>
<PackageReadmeFile>README.md</PackageReadmeFile>
<NeutralLanguage>en</NeutralLanguage>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<PackageReleaseNotes>1.6.0-beta3 - Fixed websocket message handling with empty data array</PackageReleaseNotes>
<PackageReleaseNotes>https://github.com/JKorf/Okx.Net?tab=readme-ov-file#release-notes</PackageReleaseNotes>
</PropertyGroup>
<PropertyGroup>
<DocumentationFile>OKX.Net.xml</DocumentationFile>
Expand Down
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

A .Net wrapper for the OKX API as described on [OKX](https://www.okx.com/docs-v5/en/), including all features the API provides using clear and readable objects.
OKX.Net is client library for accessing the [OKX REST and Websocket API](https://www.okx.com/docs-v5/en/). 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.

## Supported Frameworks
The library is targeting both `.NET Standard 2.0` and `.NET Standard 2.1` for optimal compatibility
Expand Down Expand Up @@ -109,25 +109,23 @@ I develop and maintain this package on my own for free in my spare time, any sup
Make a one time donation in a crypto currency of your choice. If you prefer to donate a currency not listed here please contact me.

**Btc**: bc1qz0jv0my7fc60rxeupr23e75x95qmlq6489n8gh
**Eth**: 0x8E21C4d955975cB645589745ac0c46ECA8FAE504
**Eth**: 0xcb1b63aCF9fef2755eBf4a0506250074496Ad5b7

### Sponsor
Alternatively, sponsor me on Github using [Github Sponsors](https://github.com/sponsors/JKorf).

## Release notes
* Version 1.6.0-beta3 - 18 Feb 2024
* Version 1.6.0 - 25 Feb 2024
* Updated the position model to include stop order info
* Updated CryptoExchange.Net and implemented reworked websocket message handling. For release notes for the CryptoExchange.Net base library see: https://github.com/JKorf/CryptoExchange.Net?tab=readme-ov-file#release-notes
* Fixed websocket message handling with empty data array

* Version 1.6.0-beta2 - 10 Feb 2024
* Added UnifiedApi.Account.SetAccountModeAsync
* Updated the position model to include stop order info

* Version 1.6.0-beta1 - 06 Feb 2024
* Updated CryptoExchange.Net and implemented reworked websocket message handling. For release notes for the CryptoExchange.Net base library see: https://github.com/JKorf/CryptoExchange.Net/tree/beta?tab=readme-ov-file#release-notes
* Fixed issue in DI registration causing http client to not be correctly injected
* Added DataEvent wrapper to socket client subscription callbacks
* Updated subscriptions to return lists where multiple updates are pushed in a single websocket message
* Updated socket client PlaceOrderAsync endpoint to correctly respect client order id
* Removed redundant OkxRestClient constructor overload
* Updated some namespaces

* Version 1.5.0 - 04 Jan 2024
* Added UnifiedApi.Trading.GetAlgoOrderAsync endpoint
Expand Down

0 comments on commit 453b8e7

Please sign in to comment.