materus
/
currency-exchange-rust
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Mateusz Słodkowicz 2024-03-20 13:01:59 +01:00
parent 3a831a5194
commit a7c640048a
Signed by: materus
GPG Key ID: 28D140BCA60B4FD1
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -25,7 +25,7 @@ Options:
-L, --list-rates <currency> List exchange rate for currency
-h, --help Print help
```
Cache and api key is stored by default in `<TMPDIR>/currencyCache.db`. This location and filename can be overriden by setting up `CURRENCY_CACHE` env variable.
Cache and api key is stored by default in `<XDG_CACHE_HOME>/currencyCache.db` or `<TMPDIR>/currencyCache.db` if `XDG_CACHE_HOME` is not set. This location and filename can be overriden by setting up `CURRENCY_CACHE` env variable.
## Build
Needs rust and cargo, build tested on rust v1.76.0\
@ -42,4 +42,6 @@ To run with docker use:
docker run -it --rm -v /tmp:/tmp:rw materus/currency-exchange:latest <ARGUMENTS>
```
Dockerfile sets up `CURRENCY_CACHE` to `/tmp/docker_currency_cache.db`, to keep cache u should mount this file or tmp directory for example with `-v /tmp:/tmp:rw` in docker run cmdline.