From 9080363e7fadd325c8303695f307a6d538098c81 Mon Sep 17 00:00:00 2001
From: Michael Housh <mhoush@houshhomeenergy.com>
Date: Tue, 18 Mar 2025 22:58:53 -0400
Subject: [PATCH] feat: Updates readme.

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/README.md b/README.md
index 4023220..31ce185 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,13 @@
 # homarr
 
+Dashboard website, used to quickly store and access commonly used services.
+
+## Usage
+
+The `compose.yaml` file runs the application after setting up the environment
+variables.
+
+The `example.env` file is an example of the environment variables used to run
+this stack.  These can be set in on your host or in whatever orchestration tool
+used to run the stack.
+