From 1bb2421e9dac46a0e751c195082b0167eadf24dc Mon Sep 17 00:00:00 2001
From: "Navy.gif" <navydotgif@gmail.com>
Date: Wed, 9 Nov 2022 14:56:55 +0200
Subject: [PATCH] update readme

---
 README.md                                     | 12 ++++++++++--
 options.json                                  |  1 -
 src/server/interfaces/AbstractUserDatabase.js |  5 +++++
 3 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 7c35b6f..4780513 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,6 @@
 # Navy's webserver framework
-A template repository for creating Node.js based webservers with sharding.
+A template repository for creating Node.js based webservers with sharding.  
+Main repository: https://git.corgi.wtf/Navy.gif/webserver-framework
 
 ## Main components
 **Controller:** `/src/controller/Controller.js`  
@@ -9,4 +10,11 @@ Master process, orchestrates the whole program. Takes care of starting up the sh
 Manages the forked processes. Essentially a wrapper for ChildProcess.
 
 **Server.js:** `/src/server/Server.js`  
-Main component that runs on the forked processes. Expects a message with a `_start` property with the startup options to be sent.
\ No newline at end of file
+Main component that runs on the forked processes. Expects a message with a `_start` property with the startup options to be sent.
+
+## "Lesser" components
+**Authenticator:** `/src/server/middleware/Authenticator.js`  
+Takes care of sessions, authentication and authorisation, relies on an implementation of `AbstractUserDatabase.js`.  
+
+**UserDatabase:** `/src/server/components/UserDatabase.js`  
+Implementation of `AbstractUserDatabase.js`, takes care of user management. 
\ No newline at end of file
diff --git a/options.json b/options.json
index db5303e..26f541f 100644
--- a/options.json
+++ b/options.json
@@ -16,7 +16,6 @@
         "customColors": {"access": "green", "unauthorised": "red"}
     },
     "discord": {
-        "id": "955399395740905482",
         "scope": ["identify"],
         "version": 10
     },
diff --git a/src/server/interfaces/AbstractUserDatabase.js b/src/server/interfaces/AbstractUserDatabase.js
index b74def0..cb6cc73 100644
--- a/src/server/interfaces/AbstractUserDatabase.js
+++ b/src/server/interfaces/AbstractUserDatabase.js
@@ -1,3 +1,8 @@
+/**
+ *
+ * @abstract
+ * @class AbstractUserDatabase
+ */
 class AbstractUserDatabase {
 
     fetchUser () {