From 693efbb4a96f6f4ea195a63d563f355d03206de1 Mon Sep 17 00:00:00 2001
From: Ben Morrison <ben@gbmor.dev>
Date: Thu, 7 May 2020 17:04:52 -0400
Subject: tentative index page

---
 web/index.txt | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 web/index.txt

(limited to 'web')

diff --git a/web/index.txt b/web/index.txt
new file mode 100644
index 0000000..d108168
--- /dev/null
+++ b/web/index.txt
@@ -0,0 +1,28 @@
+This is the tilde.institute informational API
+
+Not finished. Currently planning:
+
+    /
+        - Information on endpoints and purpose
+
+    /[plain|json]
+        - Response formats
+
+    /$FMT/osversion
+        - OpenBSD version
+
+    /$FMT/pkgs
+        - Installed packages
+
+    /$FMT/query
+        ?pkg=[a-zA-Z0-9+]
+            - Check if a package is installed.
+
+    /$FMT/uptime
+        - Uptime and Load
+
+    /$FMT/usercount
+        - Number of registered user accounts
+
+    /$FMT/users
+        - List of users (maybe CSV for plaintext?) and ancillary information
-- 
cgit 1.4.1-2-gfad0