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

Leveled down README variables section.

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

10
README.md
View File

@ -9,7 +9,7 @@ reddit-post-dump requires a arbitrarily recent version of Node.js. Before use, d
`node app.js --user={username}` `node app.js --user={username}`
### Optional parameters ### Optional parameters
* `--users={user1,user2}`: You may fetch posts from multiple users by either supplying a comma-separated list of usernames (no spaces) with `--users`, or using multiple individual `--user` arguments * `--users={user1,user2}`: You may fetch posts from multiple users by either supplying a comma-separated list of usernames (no spaces) with `--users`, or by using multiple individual `--user` arguments
* `--limit={number}`: Maximum amount posts per user to fetch content from * `--limit={number}`: Maximum amount posts per user 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 * `--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
@ -25,21 +25,21 @@ To change the configuration, please refer to `config/default.js`. I recommend no
### 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 `/`.
### Variables #### Variables
#### Post ##### Post
* `$postId`: The ID of the reddit post * `$postId`: The ID of the reddit post
* `$postTitle`: The title of the reddit post * `$postTitle`: The title of the reddit post
* `$postUser`: The user that submitted the post, almost always equivalent to the `--user` command line argument * `$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 * `$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 * `$postIndex`: The index of the post according to the sort method
#### Album ##### Album
* `$albumId`: The ID of the media host album * `$albumId`: The ID of the media host album
* `$albumTitle`: The title of the media host album * `$albumTitle`: The title of the media host album
* `$albumDescription`: The description 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 * `$albumDate`: The submission date of the media host album, formatted by the `dateformat` configuration described below
#### Item (individual image, video or text) ##### Item (individual image, video or text)
* `$itemId`: The ID of the individual image or video * `$itemId`: The ID of the individual image or video
* `$itemTitle`: The title of the individual image or video * `$itemTitle`: The title of the individual image or video
* `$itemDescription`: The description of the individual image or video * `$itemDescription`: The description of the individual image or video