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

Elaborated README

This commit is contained in:
ThePendulum 2018-04-18 02:31:53 +02:00
parent 51ffd88b04
commit 5b82877ca0
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,6 +1,8 @@
# reddit-post-dump # reddit-post-dump
## Installation ## Installation
reddit-post-dump requires a arbitrarily recent version of Node.js. O
`npm install` `npm install`
## Usage ## Usage
@ -11,7 +13,9 @@
* `--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 * `--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 ## Configuration
The default configuration aims to be sensible, and the application may be used without any further tweaking. However, this application came to life because I was not satisfied by the organizatory facilities of similar applications, thus a multitude of options are at your disposal as described in this document. The default configuration aims to be sensible, and the application may be used without any further tweaking. However, a multitude of options are available
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.
### Patterns ### 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 `/`. Path patterns dictate where and how a file will be saved. Various variables and options are available, and you may use subdirectories divided by `/`.
@ -41,7 +45,7 @@ Path patterns dictate where and how a file will be saved. Various variables and
#### `dateFormat` #### `dateFormat`
Affects the representation of `$postDate`, `$albumDate` and `$itemDate` and defaults to `YYYYMMDD`. See [this documentation](https://date-fns.org/v1.29.0/docs/format) for an overview of all available tokens. Affects the representation of `$postDate`, `$albumDate` and `$itemDate` and defaults to `YYYYMMDD`. See [this documentation](https://date-fns.org/v1.29.0/docs/format) for an overview of all available tokens.
#### `titleLimit` #### `titleLength`
Titles can sometimes be longer than you prefer your filenames to be, or even overflow the operating system's limit (255 bytes for Linux). This property cuts off titles at a fixed number of characters. Titles can sometimes be longer than you prefer your filenames to be, or even overflow the operating system's limit (255 bytes for Linux). This property cuts off titles at a fixed number of characters.
#### `indexOffset` #### `indexOffset`