From 9ccfdb4fb14646c79c2d09c23758462a40e19028 Mon Sep 17 00:00:00 2001 From: Luke Wilson Date: Sat, 17 May 2025 08:58:08 -0500 Subject: [PATCH] Update readme to mention vendoring --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 43e3e23..32b220e 100644 --- a/README.md +++ b/README.md @@ -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)