From 084ec28adef9f16a0f38f0457662e9695dfcff8a Mon Sep 17 00:00:00 2001
From: mo khan <mo@mokhan.ca>
Date: Mon, 17 Mar 2025 16:32:11 -0600
Subject: feat: use csv files to simulate database tables

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

(limited to 'README.md')

diff --git a/README.md b/README.md
index e29e796d..cf7af05c 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,30 @@ I have ommitted TLS, RS256 from the prototype to offload the decision of key
 management and rotation. See [smallstep](https://smallstep.com/docs/step-cli/)
 for PKI management.
 
+CSV files are used instead of a database to simulate different types of
+scenarios. The following organizational hierarchy is demonstrated here:
+
+```
+Organization(name: "default")
+  * Group(name: "A")
+    * Project(name: "A1"
+  * Group(name: "B")
+    * Project(name: "B1"
+Organization(name: "gitlab")
+  * Group(name: "gitlab-org")
+    * Project(name: "gitlab")
+  * Group(name: "gitlab-com")
+    * Group(name: "gl-security")
+      * Group(name: "test-projects")
+        * Project(name: "eicar-test-project")
+      * Project(name: "disclosures")
+    * Group(name: "support")
+      * Group(name: "toolbox")
+        * Project(name: "changelog-parser")
+    * Project(name: "handbook")
+    * Project(name: "www-gitlab-com")
+```
+
 ## Getting Started
 
 1. Install tools:
@@ -69,7 +93,7 @@ for PKI management.
     $ mage
     ```
 
-1. Open browser to `http://ui.example.com:8080/saml/new` to start a new SAML
+1. Open a browser to `http://ui.example.com:8080/saml/new` to start a new SAML
    session. Or open `http://ui.example.com:8080/oidc/new` to start a new OIDC
    session.
 
-- 
cgit v1.2.3