From 66f245b2e7d27e4ed6811ee88fe2f5bb843c8b28 Mon Sep 17 00:00:00 2001 From: DebaucheryLibrarian Date: Wed, 11 Sep 2024 05:16:53 +0200 Subject: [PATCH] Elaborated README. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d8459f7..cd2f37a 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ reddit-post-dump requires a arbitrarily recent version of Node.js. O * `--sort={method}`: How posts should be sorted while fetched. This affects the `$postIndex` variable, and in combination with a `--limit` decides what posts will be included ## Configuration -The default configuration aims to be sensible, and the application may be used without any further tweaking. However, a multitude of options are available +The default configuration aims to be sensible, and the application may be used without any further tweaking. However, a multitude of options make this utility particularly powerful. -To change the configuration, you may edit `config/default.js` directly, or if you wish to preserve the defaults (recommended), create `config/local.json` (JSON) or `config/local.js` (JavaScript). This file only needs to contain the properties you wish to override, but you may wish to copy `config/default.js` to `config/local.js` for convenience. +To change the configuration, please refer to `config/default.js`. I recommend not editing this file directly, but instead making a copy `config/local.js`. The default configuration can be a useful reference for restoring any detrimental configuration errors, and may be overwritten by updates. The structure of `config/local.js` needs to match that of the default configuration, but does not need to contain any properties you do not wish to override. If preferred, you may instead use JSON in `config/local.json`. ### Patterns Path patterns dictate where and how a file will be saved. Various variables and options are available, and you may use subdirectories divided by `/`.