diff --git a/docs/assets/images/struct.png b/docs/assets/images/struct.png new file mode 100644 index 0000000..7a4b713 Binary files /dev/null and b/docs/assets/images/struct.png differ diff --git a/docs/index.html b/docs/index.html index e3a12b2..ac2e0da 100644 --- a/docs/index.html +++ b/docs/index.html @@ -122,15 +122,16 @@
-

CryptoExchange.Net

+

CryptoExchange.Net & Implementations

CryptoExchange.Net is a base library which is used to implement different cryptocurrency (exchange) API's. It provides a standardized way of implementing different API's, which results in a very similar experience for users of the API implementations.

-
All libraries can be used in the same project as well as individually, just install the exchange libraries you need!
-

The following API's are directly supported. Note that there are 3rd party implementations going around, but only these are created and supported by me

+

When access to multiple or all exchange API's is needed, the CryptoClients.Net library combines all different client libraries in a single Nuget package. The following image illustrates the structure:

+

+

These Exchanges/API's are directly supported:

- + @@ -147,12 +148,12 @@
ExchangeAPI Repository Nuget
MexcJKorf/Mexc.Net
OKXJKorf/OKX.Net
- -

Alternatively, use CryptoClients.Net which combines these packages and allows easy access to all exchange API's.

+

Note that there are 3rd party implementations going around, but only the listed ones here are created and supported by me.

+

When using multiple of these API's the CryptoClients.Net package can be used which combines these packages and allows easy access to all exchange API's.

Supported Frameworks

- The library is targeting both .NET Standard 2.0 and .NET Standard 2.1 for optimal compatibility + The libraries are targeting both .NET Standard 2.0 and .NET Standard 2.1 for optimal compatibility

@@ -1376,14 +1377,14 @@ await client.UnsubscribeAllAsync(); ============================ -->

Common Clients

-

CryptoClients.Net exposes some common clients. These clients aim to make using the different API's easier.

+

The CryptoClients.Net client exposes some common client classes. These clients aim to make using the different API's easier.

(I)ExchangeRestClient
- The ExchangeRestClient (or ExchangeRestClient when used directly) can be used to easily access REST clients for different API's. + The IExchangeRestClient (or ExchangeRestClient when used directly) can be used to easily access REST clients for different API's.

For example, using the Binance, Bybit and Kucoin API's can be done like this: - 

var exchangeRestClient = new ExchangeRestClient(); // Either construct it or inject the IExchangeRestClient into your service
+			
var exchangeRestClient = new ExchangeRestClient(); // Either construct it or inject the IExchangeRestClient into your service after having called 'AddCryptoClients()' during service regirations
 var binanceTicker = await exchangeRestClient.Binance.SpotApi.ExchangeData.GetTickersAsync();
 var bybitTicker = await exchangeRestClient.Bybit.V5Api.ExchangeData.GetTickers();
 var kucoinTicker = await exchangeRestClient.Kucoin.SpotApi.ExchangeData.GetTickers();

@@ -1393,7 +1394,7 @@ var kucoinTicker = await exchangeRestClient.Kucoin.SpotApi.ExchangeData.GetTicke
 		  Similarly as the (I)ExchangeRestClient this client allows you to access the different Websocket clients through a single access point.
 		  

 		  
For example accessing the Bitget, Kraken and OKX API's could be done like this:
-		  
var exchangeSocketClient = new ExchangeSocketClient(); // Either construct it or inject the IExchangeSocketClient into your service
+		  
var exchangeSocketClient = new ExchangeSocketClient(); // Either construct it or inject the IExchangeSocketClient into your service after having called 'AddCryptoClients()' during service regirations
 var bitgetSub = await exchangeSocketClient.Bitget.SpotApi.SubscribeToTickerUpdatesAsync("ETHUSDT", data => {});
 var krakenSub = await exchangeSocketClient.Kraken.SpotApi.SubscribeToTickerUpdatesAsync("ETH/USD", data => {});
 var okxSub = await exchangeSocketClient.OKX.UnifiedApi.ExchangeData.SubscribeToTickerUpdatesAsync("ETH-USDT", data => {});