diff --git a/README.md b/README.md index bee64c9..22f1702 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # papis-bbt-formatter -Formats reference keys in papis similarly to the (zotero plugin) `better-bibtex` keys, in the format `Name2008TitleShort`. +Formats reference keys in papis similarly to the (zotero plugin) `better-bibtex` keys, in formats such as `Name2008TitleShort`, `Name2008titleshort`, or `Name2008`. ## Installation @@ -39,11 +39,14 @@ In your papis configuration file (usually `~/.config/papis/config`), add the fol ```cfg [settings] -formater = bbt +formatter = bbt ref-format = bbt: ``` -For now, the ref-format also _has_ to start with `bbt:`. +The formatter is set to `bbt` which will invoke it for every formatting operation +(see the `default-formatter` setting for formatting things other than the ref-key). + +For now, the ref-format also _has_ to start with `bbt:` so that the formatter picks it up. Formatted reference keys by default will look like: @@ -59,7 +62,7 @@ Listed below are all options with their defaults: ```cfg [settings] -formater = bbt +formatter = bbt ref-format = bbt: [plugins.bbt]