From e0d3673730e2b9e7c9f0cceff6c31e17876dbdc4 Mon Sep 17 00:00:00 2001
From: cynic <kurisufag1@gmail.com>
Date: Sat, 31 Dec 2022 20:13:27 -0500
Subject: [PATCH] add spec

---
 towers/users.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/towers/users.py b/towers/users.py
index 3de453b..2d8d2bc 100644
--- a/towers/users.py
+++ b/towers/users.py
@@ -1,3 +1,6 @@
+# all plugins have two critical components: `hooks`, which is a list of regex matches that identify
+#  the URL range this plugin catches, and `run`, which is called on match using the framework context
+#  (i.e. the main class) and a copy of the HTTP request.
 
 hooks = ["http.*:\/\/users.$HOST.*"]
 
@@ -5,4 +8,4 @@ def run(ctx, r):
     return {
         "content_type": "text/html",
         "body": "<h1>all users registered on system</h1>"+("<br>".join(ctx.auth.get_real_users()))
-    }
\ No newline at end of file
+    }