From 36b6504a38241b242b73a10e074bf8ef73323efe Mon Sep 17 00:00:00 2001 From: Sam Fredrickson Date: Tue, 19 Mar 2024 21:47:47 -0700 Subject: [PATCH] Remarks on configuration in the README. --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fa26ce9..b454cff 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,14 @@ program. It's written in Go using the [Bubble Tea][tea] library, and uses [tea]: https://github.com/charmbracelet/bubbletea [coin]: https://www.coindesk.com +### Configuration + +By default, the program will use Bitcoin along with various goals and bases +of comparison. With the `--config-file` flag, however, one can specify a TOML +file that overrides these defaults. + +See [this one for Ethereum](./config/eth.toml) for an example. + ### "Theory" Given a pair of quotes taken at the start and end of some period, @@ -39,8 +47,7 @@ $$ x = {{log(p_f) - log(p_e)} \over log(r)} $$ ### Future Improvements -* Support other assets available from Coindesk. -* Configurable projection milestones. +* Add more default configurations for various assets. * Allow projection by date, e.g. use the CDPR to calculate what the price would be on a particular date. * Log errors to a file.