diff --git a/README.md b/README.md index 22f1702..bee64c9 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 formats such as `Name2008TitleShort`, `Name2008titleshort`, or `Name2008`. +Formats reference keys in papis similarly to the (zotero plugin) `better-bibtex` keys, in the format `Name2008TitleShort`. ## Installation @@ -39,14 +39,11 @@ In your papis configuration file (usually `~/.config/papis/config`), add the fol ```cfg [settings] -formatter = bbt +formater = bbt ref-format = 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. +For now, the ref-format also _has_ to start with `bbt:`. Formatted reference keys by default will look like: @@ -62,7 +59,7 @@ Listed below are all options with their defaults: ```cfg [settings] -formatter = bbt +formater = bbt ref-format = bbt: [plugins.bbt]