From 1b365ef7732bf4e2f06b157db70b96f2e230ab28 Mon Sep 17 00:00:00 2001 From: DebaucheryLibrarian Date: Wed, 11 Sep 2024 05:16:53 +0200 Subject: [PATCH] Leveled down README variables section. --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 376e7f8..e54a960 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ reddit-post-dump requires a arbitrarily recent version of Node.js. Before use, d `node app.js --user={username}` ### 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 * `--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 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 -#### Post +#### Variables +##### Post * `$postId`: The ID 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 * `$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 -#### Album +##### Album * `$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 -#### Item (individual image, video or text) +##### Item (individual image, video or text) * `$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