Examples/docs

JKorf · Mar 1, 2024 · fa9ed58 · fa9ed58
1 parent 88dfa99
commit fa9ed58
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 13 deletions.
diff --git a/Examples/Bybit.Examples.Authentication/Bybit.Examples.Authentication.csproj b/Examples/Bybit.Examples.Authentication/Bybit.Examples.Authentication.csproj
diff --git a/Examples/Bybit.Examples.Authentication/Program.cs b/Examples/Bybit.Examples.Authentication/Program.cs
diff --git a/...bit.Console/Bybit.Examples.Console.csproj → ...les.Console/Bybit.Examples.Console.csproj b/...bit.Console/Bybit.Examples.Console.csproj → ...les.Console/Bybit.Examples.Console.csproj
diff --git a/Examples/Bybit.Console/Program.cs → Examples/Bybit.Examples.Console/Program.cs b/Examples/Bybit.Console/Program.cs → Examples/Bybit.Examples.Console/Program.cs
diff --git a/Examples/README.md b/Examples/README.md
@@ -0,0 +1,7 @@
+# Examples
+
+### Bybit.Examples.Api
+A minimal API showing how to integrate Bybit.Net in a web API project
+
+### Bybit.Examples.Console
+A simple console client demonstrating basic usage
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ The library is targeting both `.NET Standard 2.0` and `.NET Standard 2.1` for op
 	});
 	```
 
-For information on the clients, dependency injection, response processing and more see the [documentation](https://jkorf.github.io/CryptoExchange.Net), or have a look at the examples [here(https://github.com/JKorf/Bybit.Net/tree/main/Examples)] and [here](https://github.com/JKorf/CryptoExchange.Net/tree/master/Examples).
+For information on the clients, dependency injection, response processing and more see the [documentation](https://jkorf.github.io/CryptoExchange.Net), or have a look at the examples [here](https://github.com/JKorf/Bybit.Net/tree/main/Examples) and [here](https://github.com/JKorf/CryptoExchange.Net/tree/master/Examples).
 
 ## CryptoExchange.Net
 Bybit.Net is based on the [CryptoExchange.Net](https://github.com/JKorf/CryptoExchange.Net) base library. Other exchange API implementations based on the CryptoExchange.Net base library are available and follow the same logic.