diff --git a/README.md b/README.md index d109f4d..27bfbc9 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,19 @@ note: this module depends on having an api key for the following services [RapidAPI](https://rapidapi.com/marketplace) (used for the yahoo-finance api endpoints, which you must subscribe to in your account settings) [CoinAPI](https://www.coinapi.io/Pricing) +## Setup +plug in API keys for both your RapidAPI yahoo finance app and your CoinAPI account in the config file (either before packaging in the base-config, or directly in the maubot interface after loading). + +update the commands you want to use, by default stock data is returned with the `!stonks` command, and crypto data is returned with `!hodl` command. for example: + +`!stonks tsla` + +would return something like this: +![stonks response](images/stonks.png) + +and + +`!hodl btc/ada` + +would return something like this: +![hodl response](images/hodl.png) diff --git a/images/hodl.png b/images/hodl.png new file mode 100644 index 0000000..5b0451f Binary files /dev/null and b/images/hodl.png differ diff --git a/images/stonks.png b/images/stonks.png new file mode 100644 index 0000000..56cb5c3 Binary files /dev/null and b/images/stonks.png differ