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

Mentioning API registration requirement in README.

This commit is contained in:
DebaucheryLibrarian 2024-09-11 05:16:55 +02:00
parent a596234657
commit e6e989811c
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -53,10 +53,13 @@ reddit-post-dump requires a arbitrarily recent version of Node.js. Before use, d
The audio stream for videos with sound uploaded to reddit directly (v.redd.it) is hosted separately, and will be saved as such alongside the video (typically {filename}-0 and {filename}-1). For them to be muxed into a single file automatically, **ffmpeg must be available on the system**, and the separate source files will be deleted when muxing has succeeded. If ffmpeg is not available, the separate files will remain as is.
## 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.
The default configuration aims to be sensible. 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`, 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`.
### API keys
Unfortunately, it is necessary to register for the reddit and imgur APIs for this application to work reliably. Example details have been provided in `config/default.js`, but must be overwritten (preferably in `config/local.js`). More information on registering APIs will become available in this section soon.
### Library
Path patterns dictate where and how a file will be saved. Various variables and options are available, and you may use subdirectories divided by `/`.