add config option to set name

2025-12-13 10:43:59 +00:00 · 2021-05-01 11:48:04 +01:00
parent b2c94f1e88
commit 731f71610d
2 changed files with 20 additions and 3 deletions
--- a/readme.md
+++ b/readme.md
@@ -19,6 +19,18 @@ root directory.

 Then you just have to point a webserver at your notes directory.

+## Config
+
+`notes2web` looks for a config file called `.notes2web.conf` in your current directory and your home
+directory.
+Right now the only config available is `name`:
+
+```bash
+name="alv"
+```
+
+If the name is not set, the title is set to 'notes'.
+
 ## Uninstall

 ```