]> git.g-eek.se Git - ranknauto.git/commitdiff
Doc. Update instructions to include piped tables v.0.6
authorGustav Eek <gustav.eek@fripost.org>
Mon, 27 Mar 2023 22:21:54 +0000 (00:21 +0200)
committerGustav Eek <gustav.eek@fripost.org>
Mon, 27 Mar 2023 22:22:33 +0000 (00:22 +0200)
README

diff --git a/README b/README
index 4d6cc9574d01245c6d15501d8e28bf276df5b8f4..5b75e94a4bcf8561f950712ceb1e16ce53c24da5 100644 (file)
--- a/README
+++ b/README
@@ -43,25 +43,39 @@ echo -ne "Första post\nAndra\nTredje plats\nOch fjärde\n" \
     | ranknauto -s heavy
 ```
 
-Bullet lists are respected, so bullet that are fed will remain in the
-output. Already ranked lists can be inserted; the previous
-ranking is ignored. Empty lines are ignored.
+Bullet lists, numbered item lists and piped tables are all respected.
+That means that bullets which are fed will remain in the output. The
+numbering is regenerated, starting from 1. List patterns are preserved
+at best effort, the widest input number is used for pattern
+definition, and output is adopted for right alignment. Piped tables
+are similarly regenerated.
 
-The same holds for numbered item lists. The numbering is regenerated,
-starting from 1. The list pattern is however preserved at best effort,
-the widest input number is used for pattern definition, and output
-is adopted for right alignment.
+Also already ranked lists can be inserted; the previous ranking is
+ignored. Empty lines are ignored.
 
 Example:
 
 ```
-echo -ne "\n * 48 %   Första post\n *  9 %  Och fjärde\n * 16 %   Tredje plats\n * 27 %  Andra\n" \
-    | ranknauto
-echo -ne "\n 3) 48 %  Första post\n 4)  9 % Och fjärde\n 5) 16 %  Tredje plats\n 6) 27 % Andra\n" \
-    | ranknauto
+cat <<EOF | ranknauto
+ * 48 %       Första post
+ *  9 %       Och fjärde
+ * 16 %       Tredje plats
+ * 27 %       Andra
+EOF
+cat <<EOF | ranknauto
+ 3) 48 %      Första post
+ 4)  9 %      Och fjärde
+ 5) 16 %      Tredje plats
+ 6) 27 %      Andra
+EOF
+cat <<EOF | ranknauto
+ | 48 % | Första post  |
+ |  9 % | Och fjärde   |
+ | 16 % | Tredje plats |
+ | 27 % | Andra        |
+EOF
 ```
 
-
 Copying
 =======