From 0c4a463052b2615d9650800a726c2afe7b9e2c16 Mon Sep 17 00:00:00 2001
From: Janis Hutz <development@janishutz.com>
Date: Sat, 19 Sep 2026 17:15:47 +0200
Subject: [PATCH] chore: add usage to readme

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

diff --git a/README.md b/README.md
index 14b3a1f..bd1c02f 100644
--- a/README.md
+++ b/README.md
@@ -8,3 +8,37 @@ OIDC_CLIENT_SECRET=<client secret>
 OIDC_ISSUE=<issuer url>
 ```
 If these env vars are not present, then depending on configuration, stubs will be used for the endpoints or the program will crash
+
+
+## Usage
+```go
+package main
+
+import (
+	"os"
+
+	"github.com/gin-contrib/sessions"
+	"github.com/gin-contrib/sessions/memstore"
+	"github.com/gin-gonic/gin"
+	"github.com/janishutz/oidclogin"
+)
+
+func main() {
+	r := gin.Default()
+
+	// TODO: Better secret
+	store := memstore.NewStore([]byte("secret"))
+	r.Use(sessions.Sessions("jhid", store))
+
+	oidclogin.Configure(r, os.Getenv("APP_BASE_URL"), "/account", false)
+	r.LoadHTMLGlob("public/*")
+
+	r.GET("/account", oidclogin.EnsureLogin(false), func(ctx *gin.Context) {
+		ctx.HTML(200, "main.tmpl", gin.H{})
+	})
+
+	r.Run()
+}
+```
+This example further needs the environment variable `APP_BASE_URL` set to something like `https://app.example.org`.
+Further, you should create a template file called `main.tmpl` and also copy over the template files in the `public` directory here and edit them.