Skip to content

Commit 2e07d69

Browse files
committed
Update documentation
1 parent ce8cafc commit 2e07d69

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Binance Bot
1+
# Market Bot for Binance Exchange
2+
23
_Naive Market Maker Bot for Binance._
34

45
Solution contains two console projects:
@@ -17,28 +18,35 @@ to _create real order_ in order book.
1718

1819

1920
## Roadmap
21+
2022
#### Throlling
23+
2124
Binance has numerous limits to requests, orders count, min/max volume of order, etc. The networks restrictions should be taken into BinanceBot working as part of `BinanceClientConfiguration`,
2225
and the orders restrictions - as part of `MarkerStrategyConfiguration`.
2326

2427
#### Security
28+
2529
Binance API keys should be stored in secured storage (such as `Azure Key Vault` service) instead of plain text such it is now.
2630

2731
#### Configurations
32+
2833
Any configuration (of connectors or bot) should be placed in separate configuration storage (such as `JSON files` in local file system).
2934
This will allow you to reconfigure the bot without the need for recompilation.
3035

3136
#### Other
37+
3238
BinanceBot doesn’t processed network connection errors.
3339
It would be to implement `Retry Policies` for the broken connections and handling other network errors.
3440

3541
The solution doesn’t contain any `Unit Tests`/`Integration Tests`, which is a bad practice.
3642

3743
## Requirements
38-
__.NET Core 2.1__ (also compatible with .NET 4.5.1, .NET 4.5.2, .NET 4.6.1, .NETSTANDARD2.0).
44+
45+
- .NET Core 3.1.
3946

4047

4148
## References
49+
4250
1. [Binance official API docs](https://github.com/binance-exchange/binance-official-api-docs).
4351
2. [Official C# Wrapper for the Binance exchange API](https://github.com/glitch100/BinanceDotNet).
4452

0 commit comments

Comments
 (0)