Create README.md

This commit is contained in:
Mateusz Słodkowicz 2024-03-14 19:53:10 +01:00 committed by GitHub
parent 4efafdd85b
commit f052452a30
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 35 additions and 0 deletions

35
README.md Normal file
View File

@ -0,0 +1,35 @@
# Currency Exchange
Currency exchange app using ExchangeRate-API.\
To use, need ExchangeRate-API Key which is obtainable [here](https://www.exchangerate-api.com/)
## Usage
Before using get your API-KEY and set it up with command or by using interactive mode
```
currency-exchange --set-api-key <API_KEY>
# or
currency-exchange --interactive
```
More information on usage:
```
Usage: currency-exchange [OPTIONS] [CURRENCY_FROM] [CURRENCY_TO] [VALUE]
Arguments:
[CURRENCY_FROM] Currency code to exchange from
[CURRENCY_TO] Currency code to exchange to
[VALUE] Currency amount to exchange
Options:
-k, --set-api-key <API_KEY> Set api key
-r, --recreate-cache Recrate cache
-i, --interactive Interactive mode
-l, --list List currencies
-L, --list-rates <LIST_RATES> List currencies
-h, --help Print help
```
# Build
Needs rust and cargo, build tested on rust v1.76.0\
To build run command
```
cargo build -r
```