From 5b82877ca035c7bb82440d96507c7a51f9fef188 Mon Sep 17 00:00:00 2001 From: Niels Simenon Date: Wed, 18 Apr 2018 02:31:53 +0200 Subject: [PATCH] Elaborated README --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6a939fe..d8459f7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # reddit-post-dump ## Installation +reddit-post-dump requires a arbitrarily recent version of Node.js. O + `npm install` ## 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 ## 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 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` 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. #### `indexOffset`