Skip to content

Commit 424ecff

Browse files
committed
chore(docs): Updated the config information in the documentation
1 parent c944e55 commit 424ecff

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

docs/config/config-yaml.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -96,28 +96,37 @@ Most of the data is built on User Agent. It is possible to disable analytics in
9696
- `work`: Enable or disable analytics.
9797

9898
## Currency
99-
`DuckDuckGo` (fiat currency collection) is used to collect currency rates.
99+
`DuckDuckGo` (fiat currency collection) and `CoinMarketCap` (cryptocurrency collection)
100+
are used to collect currency rates.
100101

101102
??? note
102103
```yaml
103104
...
104105
currency:
105-
chart:
106-
save: false
107-
collecting:
108-
fiat: true
109-
schedule: '30 8 * * *'
110-
fiat:
106+
chart:
107+
save: false # Enable or disable saving graphs to an image (Boolean)
108+
collecting:
109+
fiat: true # Turn off or turn on the collection of the fiat currency rate [Boolean]
110+
crypto: false
111+
schedule: '30 8 * * *' # Currency collection schedule in crontab format [String]
112+
crypto_apikey: 'APIKEY'
113+
fiat: # List of fiat currency to save the exchange rate [Array]
111114
- USD
112115
- RUB
113116
- EUR
114117
- UAH
115118
- TRY
116119
- KZT
120+
crypto:
121+
- ETH
122+
- TON
123+
- USDT
117124
```
118125

119126
- `currency.chart.save`: Enable or disable saving graphs.
120127
- `currency.collecting`: Enable or disable cryptocurrency or fiat currency exchange rate collection.
121128
- `currency.schedule`: Currency collection interval (Configurable via cron.
122129
It is recommended to use [crontab.guru](https://crontab.guru), not supported in `Non-standard format`, like `@daily`).
123-
- `currency.fiat`: A list of fiat currencies that will be saved to the database.
130+
- `crypto.crypto_apiKey`: API-key from CoinMarketCap service
131+
- `currency.fiat`: A list of fiat currencies that will be saved to the database.
132+
- `currency.crypto`: A list of crypto currencies that will be saved to the database.

0 commit comments

Comments
 (0)