diff --git a/README.md b/README.md index fef0e327..8244d452 100644 --- a/README.md +++ b/README.md @@ -210,15 +210,22 @@ Tested on: ## Custom Parsers -Custom local plugins may be placed in a "jc/jcparsers" folder in your local "App data directory" (For example, "/home/*myname*/.local/jc/jcparsers" on Linux, "/Users/*myname*/Library/Application Support/jc/jcparsers" on Mac OS X, or "C:\Users\*myname*\AppData\Local\jc\jc\jcparsers" on Windows. +Custom local plugins may be placed in a `jc/jcparsers` folder in your local **"App data directory"**: -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 file names must be valid python module names, therefore must consist entirely of alphanumerics and start with a letter. Local plugins may override default plugins. +- Linux: `/home/*myname*/.local/jc/jcparsers` +- macOS: `/Users/*myname*/Library/Application Support/jc/jcparsers` +- Windows: `C:\Users\*myname*\AppData\Local\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 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. ## Contributions Feel free to add/improve code or parsers! You can use the [`jc/parsers/foo.py`](https://github.com/kellyjonbrazil/jc/blob/master/jc/parsers/foo.py) parser as a template and submit your parser with a pull request. ## Acknowledgments +- Local parser plugin feature contributed by https://github.com/duelafn - CI automation and code optimizations from https://github.com/philippeitis - `ifconfig-parser` module from https://github.com/KnightWhoSayNi/ifconfig-parser - `xmltodict` module from https://github.com/martinblech/xmltodict by Martín Blech