From c6bc10e37de9abf8559068e81c45a60bf7010a55 Mon Sep 17 00:00:00 2001
From: nea <romangraef@gmail.com>
Date: Wed, 19 May 2021 21:39:09 +0200
Subject: readme

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..86eb6ce
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+## Curr
+
+Currency converting CLI written in Kotlin.
+
+### Installation
+
+Install [kscript](https://github.com/holgerbrandl/kscript#installation) and run this
+
+```bash
+# Also run this again to update:
+sudo curl -L https://raw.githubusercontent.com/romangraef/curr/master/curr --output /usr/bin/curr && sudo chmod +x /usr/bin/curr
+```
+
+Get an account at [Currency API](https://currencyapi.net/) and place your API KEY into the `CURRENCY_API_KEY`, for example in `~/.profile`
+
+```bash
+export CURRENCY_API_KEY="xxxxxxxxxxxxxxxx"
+```
+
+#### Uninstall
+
+```bash
+sudo rm /usr/bin/curr
+```
+
+
+
+
-- 
cgit