summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDylan Bolger <dylan.bolger00@gmail.com>2023-10-15 11:43:55 -0500
committerDylan Bolger <dylan.bolger00@gmail.com>2023-10-15 11:43:55 -0500
commitff1777904e1bbf99d56da5b5f32e29b045406965 (patch)
tree6594ef29173eb1a59dac6126588821d5fbb2b617
parentb5d1b9378adfd8337b3a949b3565b989e0f07db4 (diff)
downloadcity-utilities-restful-wrapper-ff1777904e1bbf99d56da5b5f32e29b045406965.tar.xz
city-utilities-restful-wrapper-ff1777904e1bbf99d56da5b5f32e29b045406965.zip
Add README
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bc43363
--- /dev/null
+++ b/README.md
@@ -0,0 +1,7 @@
+# city-utilities-restful-wrapper
+A REST service to request data from my energy provider.
+
+Implemented alongside RESTful Sensor integration:
+https://www.home-assistant.io/integrations/sensor.rest/
+
+Credentials can be provided in a `credentials.py` file. \ No newline at end of file