From 0018aaddf5a76cc03a761ef01b065ff2183f9d17 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Mon, 11 Dec 2023 16:57:16 -0800 Subject: [PATCH] readme update --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7c9fae8..344559d 100644 --- a/README.md +++ b/README.md @@ -54,16 +54,17 @@ $ | jtbl [OPTIONS] ``` ### Options - `--cols=n` manually configure the terminal width -- `-c` CSV table output -- `-f` fancy table output -- `-h` help - prints help information -- `-H` HTML table output -- `-m` markdown table output -- `-n` no-wrap - no data wrapping if too long for the terminal width (overrides `--cols` and `-t`) -- `-q` quiet - don't print error messages to STDERR -- `-r` rotate the data (each row turns into a table of key/value pairs) -- `-t` truncate data instead of wrapping if too long for the terminal width -- `-v` prints version information +- `-c`, `--csv` CSV table output +- `-d`, `--dokuwiki` Dokuwiki table output +- `-f`, `--fancy` fancy table output +- `-h`, `--help` prints help information +- `-H`, `--html` HTML table output +- `-m`, `--markdown` markdown table output +- `-n`, `--no-wrap` no data wrapping if too long for the terminal width (overrides `--cols` and `-t`) +- `-q`, `--quiet` don't print error messages to STDERR +- `-r`, `--rotate` rotate the data (each row turns into a table of key/value pairs) +- `-t`, `--truncate` truncate data instead of wrapping if too long for the terminal width +- `-v`, `--version` prints version information ## Compatible JSON Formats `jtbl` works best with a shallow array of JSON objects. Each object should have a few elements that will be turned into table columns. Fortunately, this is how many APIs present their data.