Remarks on configuration in the README.
This commit is contained in:
parent
60a4574c5a
commit
36b6504a38
11
README.md
11
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.
|
||||
|
Loading…
Reference in New Issue
Block a user