From bf93d60bf12780ddd838fbbd6bd051b1fc43b9a6 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Sun, 31 Jul 2022 10:52:00 -0700 Subject: [PATCH] doc update --- README.md | 6 +++--- man/jc.1 | 4 ++-- templates/manpage_template | 2 +- templates/readme_template | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c61b0c02..3d1a7aec 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ for an example. # JC JSON Convert -`jc` JSONifies the output of many CLI tools and file-types for easier parsing in -scripts. See the [**Parsers**](#parsers) section for supported commands and -file-types. +`jc` JSONifies the output of many CLI tools, file-types, and common strings +for easier parsing in scripts. See the [**Parsers**](#parsers) section for +supported commands, file-types, and strings. ```bash dig example.com | jc --dig ``` diff --git a/man/jc.1 b/man/jc.1 index 366b1da3..8657bd47 100644 --- a/man/jc.1 +++ b/man/jc.1 @@ -1,4 +1,4 @@ -.TH jc 1 2022-07-30 1.20.5 "JSON Convert" +.TH jc 1 2022-07-31 1.20.5 "JSON Convert" .SH NAME \fBjc\fP \- JSON Convert JSONifies the output of many CLI tools and file-types .SH SYNOPSIS @@ -9,7 +9,7 @@ or "Magic" syntax: \fBjc\fP [OPTIONS] COMMAND .SH DESCRIPTION -\fBjc\fP JSONifies the output of many CLI tools and file-types for easier parsing in scripts. \fBjc\fP accepts piped input from \fBSTDIN\fP and outputs a JSON representation of the previous command's output to \fBSTDOUT\fP. Alternatively, the "Magic" syntax can be used by prepending \fBjc\fP to the command to be converted. Options can be passed to \fBjc\fP immediately before the command is given. (Note: "Magic" syntax does not support shell builtins or command aliases) +\fBjc\fP JSONifies the output of many CLI tools, file-types, and common strings for easier parsing in scripts. \fBjc\fP accepts piped input from \fBSTDIN\fP and outputs a JSON representation of the previous command's output to \fBSTDOUT\fP. Alternatively, the "Magic" syntax can be used by prepending \fBjc\fP to the command to be converted. Options can be passed to \fBjc\fP immediately before the command is given. (Note: "Magic" syntax does not support shell builtins or command aliases) .SH OPTIONS .B diff --git a/templates/manpage_template b/templates/manpage_template index e027125a..5bb644b8 100644 --- a/templates/manpage_template +++ b/templates/manpage_template @@ -9,7 +9,7 @@ or "Magic" syntax: \fBjc\fP [OPTIONS] COMMAND .SH DESCRIPTION -\fBjc\fP JSONifies the output of many CLI tools and file-types for easier parsing in scripts. \fBjc\fP accepts piped input from \fBSTDIN\fP and outputs a JSON representation of the previous command's output to \fBSTDOUT\fP. Alternatively, the "Magic" syntax can be used by prepending \fBjc\fP to the command to be converted. Options can be passed to \fBjc\fP immediately before the command is given. (Note: "Magic" syntax does not support shell builtins or command aliases) +\fBjc\fP JSONifies the output of many CLI tools, file-types, and common strings for easier parsing in scripts. \fBjc\fP accepts piped input from \fBSTDIN\fP and outputs a JSON representation of the previous command's output to \fBSTDOUT\fP. Alternatively, the "Magic" syntax can be used by prepending \fBjc\fP to the command to be converted. Options can be passed to \fBjc\fP immediately before the command is given. (Note: "Magic" syntax does not support shell builtins or command aliases) .SH OPTIONS .B diff --git a/templates/readme_template b/templates/readme_template index 1db104f2..61fa3269 100644 --- a/templates/readme_template +++ b/templates/readme_template @@ -13,9 +13,9 @@ for an example. # JC JSON Convert -`jc` JSONifies the output of many CLI tools and file-types for easier parsing in -scripts. See the [**Parsers**](#parsers) section for supported commands and -file-types. +`jc` JSONifies the output of many CLI tools, file-types, and common strings +for easier parsing in scripts. See the [**Parsers**](#parsers) section for +supported commands, file-types, and strings. ```bash dig example.com | jc --dig ```