From 8ae367689e5a34c2688188ef8f75dde96ce01a49 Mon Sep 17 00:00:00 2001
From: Sainan <sainan@calamity.inc>
Date: Mon, 23 Dec 2024 18:17:36 +0100
Subject: [PATCH] chore: initial documentation for config.json

---
 README.md           | 5 +++++
 config.json.example | 3 +--
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 61fd7040..4dcab407 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,8 @@
 # Space Ninja Server
 
 More information for the moment here: [https://discord.gg/PNNZ3asUuY](https://discord.gg/PNNZ3asUuY)
+
+## config.json
+
+- `logger.level` can be `fatal`, `error`, `warn`, `info`, `http`, `debug`, or `trace`.
+- `myIrcAddresses` can be used to point to an IRC server. If not provided, defaults to `[ myAddress ]`.
diff --git a/config.json.example b/config.json.example
index 6a581f92..5a4b1e04 100644
--- a/config.json.example
+++ b/config.json.example
@@ -2,8 +2,7 @@
   "mongodbUrl": "mongodb://127.0.0.1:27017/openWF",
   "logger": {
     "files": true,
-    "level": "trace",
-    "__valid_levels": "fatal, error, warn, info, http, debug, trace"
+    "level": "trace"
   },
   "myAddress": "localhost",
   "httpPort": 80,