From 1a4d4fc5fc574819b9efd815085e2186434dd359 Mon Sep 17 00:00:00 2001
From: Conor <git@dbuidl.com>
Date: Thu, 13 Apr 2023 21:12:23 +0100
Subject: [PATCH 1/2] Update README.md

---
 README.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d806491..6eebd96 100644
--- a/README.md
+++ b/README.md
@@ -26,9 +26,9 @@ This script also builds the UI before a release. Alternatively, you can download
 To run the project, execute the executable built by the build script:
 
 ```bash
-./ConfigDN
+./ConfigDN serve
 ```
 
 ConfigDN will then be available at:
 - http://localhost:8090/ - UI
-- http://localhost:8090/_/ - Admin UI (Make sure you visit this before making it public as the first person to visit it will be made an admin)
\ No newline at end of file
+- http://localhost:8090/_/ - Admin UI (Make sure you visit this before making it public as the first person to visit it will be made an admin)

From 852ce78d931f570a758a3734f63b5a9905328bf6 Mon Sep 17 00:00:00 2001
From: Rishi Panthee <rrpanthe@ncsu.edu>
Date: Thu, 21 Sep 2023 18:07:53 -0500
Subject: [PATCH 2/2] Add basic public API docs

---
 docs/api_docs.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 docs/api_docs.md

diff --git a/docs/api_docs.md b/docs/api_docs.md
new file mode 100644
index 0000000..86402f0
--- /dev/null
+++ b/docs/api_docs.md
@@ -0,0 +1,35 @@
+### Please note that until ConfigDN 1.0 releases, breaking API changes might occur in small version changes. We will try to keep these docs up to date 
+
+```
+BASE_API = https://cdn.configdn.com/public_api/v1/
+Authorization = ABCXYZ
+```
+
+To get your auth token, you can vist the web UI, and the API key will be displayed at the bottom.
+
+
+
+#### Get Config
+
+GET: `$BASE_API + "/get_config/" `
+
+Headers: `Authorization : $Authorization `
+
+
+Response:
+
+```json
+
+    "s": true,
+    "d": {
+        "flag1": {
+            "v": "abcxyz"
+        },
+        "flag2": {
+            "v": ["abcxyz"]
+        }
+
+   }
+```
+
+The response JSON's `d` value holds all the data. `flag1` is an example flag, and the value of it is held within `v`. `flag2` in this example has an array for it's value.
\ No newline at end of file