From 4a31ad9628b3c7ae219b633b965ba2b794919cb5 Mon Sep 17 00:00:00 2001
From: Jason Hsu <jasonhsu2013@gmail.com>
Date: Thu, 14 Sep 2023 20:51:04 -0700
Subject: [PATCH] readme stuff

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

diff --git a/README.md b/README.md
index 393eb08..356d550 100644
--- a/README.md
+++ b/README.md
@@ -16,3 +16,21 @@ Instances created are kept track of in a local sqlite database. The instancer pe
 - POST `/instances?chal=$CHALLNAME&team=$ID` - provision an instance for specific challenge and team
 - DELETE `/instances?id=$ID` - delete challenge with id
 
+
+```mermaid
+sequenceDiagram
+    actor User
+    participant CTFd
+    participant instanced
+    participant k as kube-apiserver
+    User->>CTFd: Load Instances Page
+    CTFd->>instanced: GET /challenges?team=ID
+    instanced->>CTFd: [{expiry, name, url}, ...]
+    User->>CTFd: Restart Instance
+    CTFd->>instanced: POST /instances?chal=CHALLNAME&team=ID
+    instanced--)k: Create Objects
+    instanced->>CTFd: URL of new instance
+    CTFd->>User: Instance Created
+    Note over instanced: Instance expires
+    instanced--)k: Destroy Objects
+```
\ No newline at end of file