From f5d14a7c73ba9363188f9f1ebf130fdae633b36a Mon Sep 17 00:00:00 2001 From: dmotte <37443982+dmotte@users.noreply.github.com> Date: Sun, 29 Dec 2024 14:21:18 +0100 Subject: [PATCH] Added note about the explanation purpose --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index e3baa25..5c9f6a2 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,8 @@ The algorithm is based on the assumption that one **need to exchange** some amou This algorithm tries to **optimize the quantity** of assets to be exchanged based on the **trend** of the historical **exchange rate** values, in order to determine whether the current exchange rate is **convenient** (and therefore we should exchange **more**) or **unconvenient** (and therefore we should exchange **less**). In one simple sentence, the motto is: [_"Buy more when low!"_](https://www.investopedia.com/ask/answers/04/052704.asp) +> **Note**: the following explanation is for illustration purposes only. Please refer to the [Python code](smartchg/cli.py) for any details. + | Symbol | Variable | | ---------- | ----------------- | | $a$ | `apy` |