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

Elaborated README.

This commit is contained in:
ThePendulum 2018-04-18 03:21:47 +02:00
parent afbd07bd1e
commit db258382fb
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -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 `/`.