From a7c6c34f1cfc31ce1a63a045bcb64fdf7e336c31 Mon Sep 17 00:00:00 2001
From: Nathan Woodburn <github@nathan.woodburn.au>
Date: Wed, 19 Jun 2024 14:38:50 +1000
Subject: [PATCH] feat: Added info on regular auth

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

diff --git a/README.md b/README.md
index be9c546..7f5959e 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,32 @@ Set the following parameters:
 
 
 
+## Regular auth flow
+1. Redirect the user to `https://login.hns.au/auth?return=<return-url>`
+2. User logs in and will be returned to `https://<return-url>?username=<username>&token=<token>`
+3. Use the token to authenticate the user with `https://login.hns.au/auth/user?token=<token>`  
+   This will return the following json:  
+   ```json
+   {
+	"displayName": "Nathan.Woodburn/",
+	"email": "contact@nathan.woodburn.au",
+	"email_verified": false,
+	"family_name": "nathan.woodburn",
+	"given_name": "nathan.woodburn",
+	"id": 1,
+	"links": "https://woodburn",
+	"name": "Nathan.Woodburn/",
+	"nickname": "Nathan.Woodburn/",
+	"picture": "https://nathan.woodburn.au/assets/img/profile.png",
+	"preferred_username": "nathan.woodburn",
+	"profile": "https://login.hns.au/u/nathan.woodburn",
+	"sub": 1,
+	"uid": 1,
+	"username": "nathan.woodburn",
+	"website": "https://nathan.woodburn"
+    }
+   ```
+
 
 ## Deploy your own instance