From 50ded1dbd97d26cf01d7e1a98b40e0f0f7d02202 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Fri, 21 Jan 2022 12:31:03 -0800 Subject: [PATCH] doc update --- docs/readme.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/readme.md b/docs/readme.md index c2f10482..7c6a56ab 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -7,18 +7,22 @@ JC - JSON CLI output utility This package serializes the output of many standard unix command line tools to dictionaries and lists of dictionaries. -Interactive Documentation +## Interactive Documentation >>> help(jc) >>> help(jc.lib) >>> help(jc.util) >>> jc.get_help('parser_module_name') -Online Documentation +## Online Documentation +Latest: https://github.com/kellyjonbrazil/jc/tree/master/docs -Example: +Specific version (replace - e.g. `1.17.7`): +https://github.com/kellyjonbrazil/jc/tree/v/docs + +## Example: >>> import subprocess >>> import jc @@ -41,7 +45,9 @@ modules directly: >>> data [{'id': 64612, 'opcode': 'QUERY', 'status': 'NOERROR', ...}] -Available Functions (use `help(jc.lib)` for details): +## Available Functions + +Use `help(jc.lib)` for details: parse(parser_module_name: str, data: str | iterable) High-level API to easily access the parser. This API will find both