diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 28 insertions, 0 deletions
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 +``` + + + + |