From 30d5e40520d9bd8512f59b6fc588331c8f0d8f7f Mon Sep 17 00:00:00 2001
From: Andrew Williams <andy@tensixtyone.com>
Date: Sun, 18 Aug 2024 21:49:58 +0100
Subject: [PATCH] Update README

---
 README.md | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index e2b928f..6757d21 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,19 @@ A simple, Flask-based webfinger handler.
 
 Simple Webfinger was created to provide an OIDC href from a basic YAML configuration file. Ideally for use with Tailscale and Authentik.
 
-## Configuration
+## Running the application.
 
-The `example-config.yaml` has the basic layout of the YAML file, which has the following fields. This should be provided as `config.yaml` in the working directory you're running the process.
+`simple_webfinger` is a basic Flask application and can be configured via environment variables. 
+
+| Environment Variable           | Description                         |
+| ------------------------------ | ----------------------------------- |
+| `SIMPLE_WEBFINGER_CONFIG_FILE` | Path to the YAML configuration file |
+
+## Configuration File
+
+The `examples/example-config.yaml` file has the basic layout of the YAML configuratio, The path to the file should be provided in the environment variable  `SIMPLE_WEBFINGER_CONFIG_FILE`.
+
+### Global Values
 
 | Key         | Value Example               | Description                                                   |
 | ----------- | --------------------------- | ------------------------------------------------------------- |