From 811a0b0495819925199d70db266066197cc6824e Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Mon, 8 Jun 2020 10:54:42 -0700 Subject: [PATCH] add info regarding the local parser plugin files --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 430ee668..1f36b31d 100644 --- a/README.md +++ b/README.md @@ -197,7 +197,7 @@ Custom local parser plugins may be placed in a `jc/jcparsers` folder in your loc - macOS: `$HOME/Library/Application Support/jc/jcparsers` - Windows: `$LOCALAPPDATA\jc\jc\jcparsers` -Use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) parser as a template and simply place a `.py` file in the `jcparsers` subfolder. +Local parser plugins are standard python module files. Use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) parser as a template and simply place a `.py` file in the `jcparsers` subfolder. Local plugin filenames must be valid python module names, therefore must consist entirely of alphanumerics and start with a letter. Local plugins may override default plugins.