From f052452a30bbe6dd66dcfe95cfe98a7399cd21e0 Mon Sep 17 00:00:00 2001
From: materus <materus@podkos.pl>
Date: Thu, 14 Mar 2024 19:53:10 +0100
Subject: [PATCH] Create README.md

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..544a4be
--- /dev/null
+++ b/README.md
@@ -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
+```
+