From a73a0bffc759c157e38b917f16ad70dcf34bf4f6 Mon Sep 17 00:00:00 2001 From: Onur Cinar Date: Sat, 12 Sep 2026 15:24:58 +0000 Subject: [PATCH] Add Sharpe/Sortino Ratio to the main README Sharpe and Sortino Ratio were added to strategy/ in earlier PRs but never linked from the root README's feature list. Adds a new Performance Metrics section, matching the style of the existing Backtesting/Repositories/Docker sections. Co-Authored-By: Claude Sonnet 5 Claude-Session: https://claude.ai/code/session_01JGjWXtXJPudePHg9wm5RSq --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 5410cf5..e6958af 100644 --- a/README.md +++ b/README.md @@ -336,6 +336,14 @@ $ indicator-backtest -config backtest.json Each entry in `strategies` names a registered strategy (see `-list-strategies`) and, optionally, a `config` object. `config` is overlaid onto the strategy's default instance field by field — including into nested indicators, such as `Rsi.Rma.Period` above — so only the parameters you want to change need to be listed; everything else keeps its documented default. The available field names are the exported fields on the strategy's Go struct (e.g. [`RsiStrategy`](examples/momentum/rsi_strategy.go)) and the indicator(s) it wraps. +📊 Performance Metrics +---------------------- + +The following risk-adjusted metrics can be computed from a strategy's [Outcome](strategy/README.md#Outcome) curve, for comparing strategies beyond raw cumulative return. + +- [Sharpe Ratio](strategy/README.md#SharpeRatioWithContext) +- [Sortino Ratio](strategy/README.md#SortinoRatioWithContext) + 🐳 Docker ---------