Update readme to mention vendoring

This commit is contained in:
Luke Wilson 2025-05-17 08:58:08 -05:00
parent 90f935742e
commit 9ccfdb4fb1

View File

@ -1,6 +1,8 @@
# autotrader
> [WARNING]: There are still many bugs to be fixed, this software is not ready to be used for live trading. PRs and bug fixes welcome!
>
> If you still feel like importing the library into your project, I highly recommend vendoring it (copying it directly to the folder).
Autotrader is a forex quantitative trading engine I developed in two weeks using Go. The unique backtesting simulations runs a user-designed trading algorithm against historical market data. The simulation accounts for brokerage fees, hedging, leverage, market orders, limit orders, stop orders, and more. Once a reliable strategy has been identified, the user can run the trading algorithm they created on their live brokerage account.
@ -14,10 +16,6 @@ The following page is a report generated by Autotrader when backtesting a naive
![Profitability graph of the strategy.](images/profitability-example.jpeg)
## How to use
See the cmd/ directory for example trading strategies using this library.
## License
Zero-clause BSD (0BSD)