realign-text-table: add README.md

hydrargyrum · Oct 11, 2020 · 834c95a · 834c95a
1 parent 94320ba
commit 834c95a
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/realign-text-table/README.md b/realign-text-table/README.md
@@ -0,0 +1,27 @@
+# realign-text-table
+
+`realign-text-table` redraws malformed ASCII-drawn tables
+
+# Example
+
+`realign-text-table` reads stdin or argument file.
+When given this table as stdin:
+
+    +-----+-----+
+    | foo | bar |
+    +-----+-----+
+    | a long cell | short |
+    | x | longer cell ? |
+    +--+--+
+
+it will output a well-formed table:
+
+    +-------------+---------------+
+    |     foo     |      bar      |
+    +-------------+---------------+
+    | a long cell |     short     |
+    |      x      | longer cell ? |
+    +-------------+---------------+
+
+# Dependencies
+`realign-text-table` uses Python and PrettyTable.