From 81bac3bb78371f3dc96a943e3207e3d44a68b045 Mon Sep 17 00:00:00 2001
From: LordMathis <matus@namesny.com>
Date: Sun, 17 Dec 2023 20:22:50 +0100
Subject: [PATCH] Update README

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 73240db..2414c60 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,20 @@
-# mlflow-plugin-proxy-auth
+# Mlflow Plugin Proxy Auth
 
+Provides authentication to Mlflow server using [Proxy-Authorization](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Proxy-Authorization).
+
+## Usage
+
+Clone the repo and install the package into your virtual environment.
+
+```
+git clone https://git.namesny.com/Mathis/mlflow-plugin-proxy-auth.git
+pip install .
+```
+
+Set up mlflow environment variables
+
+```env
+MLFLOW_PROXY_USERNAME=username
+MLFLOW_PROXY_PASSWORD=password
+MLFLOW_TRACKING_AUTH="proxy_auth_provider"
+```