From: Scott Worley <scottworley@scottworley.com>
Date: Sat, 5 Oct 2024 02:07:52 +0000 (-0700)
Subject: Usage documentation
X-Git-Tag: v0.5.0~1
X-Git-Url: http://git.scottworley.com/tablify/commitdiff_plain/05473926f823daa245534848aee2577cbc0d1b44

Usage documentation
---

diff --git a/README.md b/README.md
index 94752af..fe19e7b 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,24 @@
 
 Display a flat text log as an HTML table.
 
+Input format:
+
+    row 1 label
+      column label for a thing
+      column label for a different thing: cell contents
+
+    row 2 label
+      column label for a thing
+      ...
+
+Several bang-commands are available to control output formatting:
+
+* `!col <column>` to force column ordering, overriding frequency-ordering.
+* `!colsep` to leave a insert a gap between columns (skip two lines to leave a gap between rows).
+* `!col_threshold <N>` to set the threshold at which entries get columns rather than being left as notes on the right.  Default: 2
+* `!hide <column>` to omit a column
+* `!label <column>:<new label>` to change a column's label without needing to change all the input occurrences.
+
 (For the other `tablify` that makes ascii-art tables, see [Text-RecordParser][].)
 
 [Text-RecordParser]: https://metacpan.org/dist/Text-RecordParser/view/bin/tablify