From 117e23b71515f0bbe761da3c77800da1367ea591 Mon Sep 17 00:00:00 2001 From: Onur Cinar Date: Sun, 24 Dec 2023 18:08:41 -0800 Subject: [PATCH] Readme updated. --- README.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 905c8b9..cf7f18d 100644 --- a/README.md +++ b/README.md @@ -134,17 +134,32 @@ The following list of strategies are currently supported by this package: - Separate Strategies - MACD and RSI Strategy -### Strategy Helpers +## Repository -- [Action](strategy/README.md#type-action) -- [Outcome](strategy/README.md#func-outcome) -- [Snapshot](asset/README.md#type-snapshot) +Repository serves as a centralized storage and retrieval location for [asset snapshots](asset/README.md#type-snapshot). + +The following [repository implementations](asset/README.md#type-repository) are provided. + +- [File System Repository](asset/README.md#type-filesystemrepository) +- [In Memory Repository](asset/README.md#type-inmemoryrepository) +- [Tiingo Repository](asset/README.md#type-tiingorepository) + +The [Sync function]() facilitates the synchronization of assets between designated source and target repositories by employing multi-worker concurrency for enhanced efficiency. This function serves the purpose of procuring the most recent snapshots from remote repositories and seamlessly transferring them to local repositories, such as file system repositories. ## Backtest -Backtesting is the method for seeing how well a strategy would have done. The following backtesting functions are provided for evaluating strategies. +The [Backtest functionality](strategy/README.md#type-backtest), using the [Outcome](strategy/README.md#func-outcome) to rigorously evaluates the potential performance of the specified strategies applied to a defined set of assets. It generates comprehensive visual representations for each strategy-asset pairing. -- Apply Actions +```go +backtest := strategy.NewBacktest(repository, outputDir) +backtest.Names = append(backtest.Names, "brk-b") +backtest.Strategies = append(backtest.Strategies, strategy.NewApoStrategy()) + +err = backtest.Run() +if err != nil { + t.Fatal(err) +} +``` ## Usage