diff --git a/README.md b/README.md index b63a4fe..e0e1bd6 100644 --- a/README.md +++ b/README.md @@ -13,10 +13,10 @@ The filter uses the variable `pleroma-urls` for input which can be defined in th The following two are optional. If both are defined, then the script will download avatars and will not use hotlinks. -1. (lua) `pleroma_avatar_path`: (yaml) `pleroma-avatar-path`: a string ending in `/`, the folder containing avatars as referenced by the web page (e.g ``). -2. (lua) `pleroma_avatar_save_path`: (yaml) `pleroma-avatar-save-path`: a string ending in `/`, the folder in which avatars are downloaded to. +1. (lua) `pleroma_avatar_path` = (yaml) `pleroma-avatar-path`: a string ending in `/`, the folder containing avatars as referenced by the web page (e.g ``). +2. (lua) `pleroma_avatar_save_path` = (yaml) `pleroma-avatar-save-path`: a string ending in `/`, the folder in which avatars are downloaded to. -If multiple pages will be storing avatars in the same folder, use Lua by creating a `config.lua` and assigning the variable there. If a specific page will have its own directory for images, define the variable in the manuscript's YAML header. +If multiple pages will be storing avatars in the same folder, create `config.lua` and assign the variables there. If a specific page will have its own directory for images, assign the variables in the manuscript's YAML header. The filter exports variables that can be used in a Pandoc template.