From ebd2eb3584359b03fd46ecb540c742ca0160c717 Mon Sep 17 00:00:00 2001
From: wener <wenermail@gmail.com>
Date: Fri, 8 Oct 2021 00:17:04 +0800
Subject: [PATCH] add instruction for example to README.md

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

diff --git a/README.md b/README.md
index ef428ed..b90556a 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,18 @@ Whenever possible we tried to reuse / extend existing packages like `OAuth2 for
 
 Check the `/example` folder where example code for different scenarios is located.
 
+```bash
+# start oidc op server
+# oidc discovery http://localhost:9998/.well-known/openid-configuration
+CAOS_OIDC_DEV=1 go run github.com/caos/oidc/example/server/default
+# start oidc web client
+CLIENT_ID=web CLIENT_SECRET=web ISSUER=http://localhost:9998/ SCOPES=openid PORT=5556 go run github.com/caos/oidc/example/client/app
+```
+
+- browser http://localhost:5556/login will redirect to op server
+- input id to login
+- redirect to client app display user info
+
 ## Features
 
 |                | Code Flow | Implicit Flow | Hybrid Flow | Discovery | PKCE | Token Exchange | mTLS    | JWT Profile | Refresh Token |