diff --git a/README.md b/README.md
index e69de29..f172878 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,8 @@
+# laundry_status
+
+This script generates a website that tracks the washing machine and dryer use of my apartment building. The washing machine and dryer are plugged into smartplugs (Sonoff S31s) that are running ESPHome. A homeassistant instance gets that data every 1 minute and sends it to an InfluxDB database. This script reads that database with an api key, restructures the data, and generates a website. You can see the website here: [laundry.dendroalsia.net](https://laundry.dendroalsia.net)
+
+## required libraries:
+- `tidyverse`
+- `influxdbclient`
+- `rmarkdown`