Added limit and sort parameters, post index variable and relevant usage documentation.
This commit is contained in:
@@ -6,6 +6,10 @@
|
||||
## Usage
|
||||
`node app.js --user={username}`
|
||||
|
||||
### Optional parameters
|
||||
* `--limit={number}`: Maximum amount posts to fetch content from
|
||||
* `--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, 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.
|
||||
|
||||
@@ -17,12 +21,11 @@ Path patterns dictate where and how a file will be saved. Various variables and
|
||||
* `$postTitle`: The title of the reddit post
|
||||
* `$postUser`: The user that submitted the post, almost always equivalent to the `--user` command line argument
|
||||
* `$postDate`: The submission date of the reddit post, formatted by the `dateformat` configuration described below
|
||||
|
||||
* `$postIndex`: The index of the post according to the sort method
|
||||
* `$albumId`: The ID of the media host album
|
||||
* `$albumTitle`: The title of the media host album
|
||||
* `$albumDescription`: The description of the media host album
|
||||
* `$albumDate`: The submission date of the media host album, formatted by the `dateformat` configuration described below
|
||||
|
||||
* `$itemId`: The ID of the individual image or video
|
||||
* `$itemTitle`: The title of the individual image or video
|
||||
* `$itemDescription`: The description of the individual image or video
|
||||
|
||||
Reference in New Issue
Block a user