diff --git a/README.md b/README.md index 7ec76b0..6a939fe 100644 --- a/README.md +++ b/README.md @@ -38,14 +38,14 @@ Path patterns dictate where and how a file will be saved. Various variables and * `$itemIndex`: The index of the individual image or video in an album, offset by the `indexOffset` configuration described below * `$ext`: The extension of the medium. Must typically be included, but may be omitted for self (text) posts on Unix systems -### `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. -### `titleLimit` +#### `titleLimit` 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` Arrays start at 0, but as to not tire myself out debating the matter, you may offset it my any numerical value you like. Affects the `$itemIndex` variable for album items. -### `slashSubstitute` +#### `slashSubstitute` The patterns represent Unix file paths, and a `/` therefore indicates a new directory. You may freely use directories in your paths, but titles or descriptions may contain a `/` that is not supposed to create a new directory. All instances of `/` in a variable value will be replaced with the configured slash substitute.