DebaucheryLibrarian
/
ripunzel
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Rephrased README.

This commit is contained in:
ThePendulum 2018-04-18 03:25:48 +02:00
parent 5169b80fc8
commit 09dc724afc
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -15,7 +15,7 @@ reddit-post-dump requires a arbitrarily recent version of Node.js. O
## Configuration
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, 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`.
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`, as the default configuration might be overwritten in updates and can be a useful reference for restoring any detrimental configuration errors. The structure of `config/local.js` must match the structure of the default configuration, but does not necessarily 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 `/`.