hgfd

README.md

@@ -4,7 +4,7 @@ Happy to finally bring you f0ckm! The long awaited imageboard solution that you
 
 It features extensive tagging, searching, filtering and a variety of options.
 
-The software is mostly generic, it can be modified easily via config.json to suit your communities needs. Most things can be enabled/disabled very easily and modified to needs.
+The software is mostly generic, it can be modified easily via `config.yaml` (or `config.json`) to suit your communities needs. Most things can be enabled/disabled very easily and modified to needs.
 
 The software comes without any warranties or entitlements of any kind! The developer is not responsible for anything you do with the use of this software.
 
@@ -20,7 +20,12 @@ first things
 
 fill with for example: f0ckm (prefilled)
 
-`cp config_example.json config.json`
+Copy example configuration and customize:
+
+`cp config_example.yaml config.yaml`
+`npm run config:gen`
+
+(Or `cp config_example.json config.json` if configuring directly in JSON)
 
 Edit to needs, for sql you can do this:
 
@@ -74,6 +79,13 @@ Create admin user in dev env
 `DB_HOST=localhost DB_PORT=5454 node scripts/create-admin.mjs admin 'YOUR_PASSWORD_HERE'`
 
 now visit http://localhost:1337 in your browser, you can develop without needing to rebuild the docker image for every change
+ 
+## Configuration Management
+
+You can manage configuration in YAML (`config.yaml`) or JSON (`config.json`):
+- `npm run config:gen`: Compiles `config.yaml` to `config.json`. Automatically runs before `npm run dev` and `npm start`.
+- `npm run config:watch`: Watches `config.yaml` for edits and recompiles `config.json` automatically on save.
+- `npm run config:to-yaml`: Converts existing `config.json` into `config.yaml`.
 
 ## NGINX