From 424ecff857236f2da8f82f4f6936604e8bb14eca Mon Sep 17 00:00:00 2001 From: Redume Date: Fri, 17 Jan 2025 16:11:58 +0300 Subject: [PATCH] chore(docs): Updated the config information in the documentation --- docs/config/config-yaml.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/config/config-yaml.md b/docs/config/config-yaml.md index a1d24bd..7daebbe 100644 --- a/docs/config/config-yaml.md +++ b/docs/config/config-yaml.md @@ -96,28 +96,37 @@ Most of the data is built on User Agent. It is possible to disable analytics in - `work`: Enable or disable analytics. ## Currency -`DuckDuckGo` (fiat currency collection) is used to collect currency rates. +`DuckDuckGo` (fiat currency collection) and `CoinMarketCap` (cryptocurrency collection) +are used to collect currency rates. ??? note ```yaml ... currency: - chart: - save: false - collecting: - fiat: true - schedule: '30 8 * * *' - fiat: + chart: + save: false # Enable or disable saving graphs to an image (Boolean) + collecting: + fiat: true # Turn off or turn on the collection of the fiat currency rate [Boolean] + crypto: false + schedule: '30 8 * * *' # Currency collection schedule in crontab format [String] + crypto_apikey: 'APIKEY' + fiat: # List of fiat currency to save the exchange rate [Array] - USD - RUB - EUR - UAH - TRY - KZT + crypto: + - ETH + - TON + - USDT ``` - `currency.chart.save`: Enable or disable saving graphs. - `currency.collecting`: Enable or disable cryptocurrency or fiat currency exchange rate collection. - `currency.schedule`: Currency collection interval (Configurable via cron. It is recommended to use [crontab.guru](https://crontab.guru), not supported in `Non-standard format`, like `@daily`). -- `currency.fiat`: A list of fiat currencies that will be saved to the database. \ No newline at end of file +- `crypto.crypto_apiKey`: API-key from CoinMarketCap service +- `currency.fiat`: A list of fiat currencies that will be saved to the database. +- `currency.crypto`: A list of crypto currencies that will be saved to the database. \ No newline at end of file