diff options
| author | nea <romangraef@gmail.com> | 2021-05-19 21:39:09 +0200 |
|---|---|---|
| committer | nea <romangraef@gmail.com> | 2021-05-19 21:39:09 +0200 |
| commit | c6bc10e37de9abf8559068e81c45a60bf7010a55 (patch) | |
| tree | 90613d093da943592fcbdd0a69299b555ccb94ea | |
| parent | 41cb26bcdb2a2764a09274bd358f0694c91fc9de (diff) | |
| download | curr-c6bc10e37de9abf8559068e81c45a60bf7010a55.tar.gz curr-c6bc10e37de9abf8559068e81c45a60bf7010a55.tar.bz2 curr-c6bc10e37de9abf8559068e81c45a60bf7010a55.zip | |
readme
| -rw-r--r-- | .gitattributes | 3 | ||||
| -rw-r--r-- | README.md | 28 |
2 files changed, 31 insertions, 0 deletions
diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..d70cb22 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ + +*.kts linguist-language=Kotlin + 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 +``` + + + + |