From ba0d45a4c056579bddb3b1b44fc044d35f498982 Mon Sep 17 00:00:00 2001
From: mo khan <mo@mokhan.ca>
Date: Thu, 6 Mar 2025 11:02:34 -0700
Subject: docs: add links to docs and make ascii diagram mobile friendly

---
 README.md | 72 ++++++++++++++++++++++++++++++++-------------------------------
 1 file changed, 37 insertions(+), 35 deletions(-)

diff --git a/README.md b/README.md
index ebab0c50..20e79611 100644
--- a/README.md
+++ b/README.md
@@ -16,41 +16,32 @@ Below is a recording of a SAML based service provider initiated login, displayin
 ## Architecture
 
 ```plaintext
-                -------------
-                | user-agent |
-                -------------
-                   |
-                   |
-                   V
-----------------|:8080|----------------------------------------
-                    |
-                    V
-             ---------------
-             | API Gateway | (use casbin to evict early)
-             ---------------
-                    |
-          |---------|------| (reverse proxy and injects context headers)
-          |                |
-          |                V                      -----
-          |         --------------------         (_____)
-          |         | IdP (saml, oidc) | ------- | db  |
-          |         |                  |          -----
-          |         --------------------
-          |         | :http   | :grpc  | (use declarative_policy)
-          |         --------------------
-          |                     A
-     --------------             |
-     |            |             |
-     V            V             |
-   ------    ------------       |
-   | UI |    | REST API |-------|
-   ------    ------------
-                  |
-                  V
-                _____
-               (_____)
-               | db  |
-               -------
+ -------------
+ | user-agent |
+ -------------
+       |
+       V
+----|:8080|-----------------------------------------------
+       |
+       V
+ ---------------
+ | API Gateway | (use casbin to evict early)
+ ---------------
+        | (reverse proxy and injects context headers)
+        |                               -----
+        |    --------------------      (_____)
+        |--->| IdP (saml, oidc) |----->| db  |
+        |    |                  |       -----
+        |    --------------------
+        |    | :http   | :grpc  | (use declarative_policy)
+        |    --------------------
+        |                  A
+   -----------             |
+   |         |             |
+   V         V             |
+ ------    ------------    |
+ | UI |    | REST API |----|
+ ------    ------------
 
 [UI]: ui.example.com
 [REST API]: api.example.com
@@ -130,7 +121,18 @@ Inspired by [Open Policy Agent][4] deployments. This experiment:
 
 1. What is the unique identifier for each security principal across service boundaries? (i.e. bigint, ulid, uuid, email)
 
+## References
+
+* [go tool][5]
+* [gRPC][6]
+* [protocol buffers][7]
+* [twirp][8]
+
 [1]: https://gitlab.com/gitlab-org/gitlab/-/blob/e1f6db024561e35462ac8d9f54b8f9678f6ed6ee/app/models/ability.rb#L73
 [2]: https://gitlab.com/gitlab-org/gitlab/-/tree/master/app/policies
 [3]: https://casbin.org/
 [4]: https://www.openpolicyagent.org/
+[5]: https://tip.golang.org/doc/modules/managing-dependencies#tools
+[6]: https://grpc.io/docs/
+[7]: https://protobuf.dev/programming-guides/proto3/
+[8]: https://github.com/arthurnn/twirp-ruby/wiki/Code-Generation
-- 
cgit v1.2.3