From 42e48399bbc8c720524655132328201c009be766 Mon Sep 17 00:00:00 2001
From: echicken <echicken@bbs.electronicchicken.com>
Date: Thu, 15 Aug 2024 05:40:09 +0000
Subject: [PATCH] configuration

---
 Readme.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..b0f9f6a
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,26 @@
+# nodelist-browser
+
+A replacement for `exec/fido-nodelist-browser` in the main project. Faster, better looking, less janky, gooder.
+
+## Configuration
+
+By default, `nodelist-browser` will use your `sbbsecho` settings and will use data from any nodelists you have configured there. Filling out the settings shown below is **completely optional**.
+
+If you were using `fido-nodelist-browser`, and if you had settings for it in `ctrl/modopts.ini` under `[fido_nodelist_browser]`, those settings will be automatically migrated the first time you run this script.
+
+### Example
+
+`ctrl/modopts.d/nodelist-browser.ini`
+```ini
+[nodelist-browser:domains]
+fidonet = FidoNet
+fsxnet = fsxNet
+somenet = Some Other FTN
+
+[nodelist-browser:nodelists]
+AnotherFTN = /path/to/nodelist
+```
+
+The `[nodelist-browser:domains]` section specifies **display aliases** for the domains you have configured for `sbbsecho`. Fill this out if you want to see a different name in the browser for a particular domain.
+
+The `[nodelist-browser:nodelists]` section specifies **display names** and **nodelist files** that you want to include in the browser, but are not included in your `sbbsecho` settings. Fill this out for any nodelists you have on hand but aren't actually using in your system configuration.
\ No newline at end of file
-- 
GitLab