From 5cd2938eeeab7275c53920233aa4d9ecec6b0e61 Mon Sep 17 00:00:00 2001
From: wreck <wreck@jobmachine.org>
Date: Thu, 7 Jan 2021 18:07:50 -0800
Subject: [PATCH] add a basic readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d109f4d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+a simple maubot module that responds with financial data about stock price or cryptocurrency exchange rate.
+
+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)
+