Better README.md

bessarabov · Nov 18, 2023 · 7242991 · 7242991
1 parent 93d7594
commit 7242991
Showing 1 changed file with 53 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,58 @@
 # tsv2table
 
+`tsv2table` is small command-line tool that converts Tab-Separated Values (TSV) data into a human-readable table format.
+
+## Example
+
+Row output of tsv file:
+
+```
+$ cat objects.tsv
+Name    Diameter (km)   Mass (10^24 kg) Orbital Period (days)
+Sun     1392684 1989100
+Mercury 4880    0.330   88
+Venus   12104   4.87    225
+Earth   12742   5.97    365.25
+Mars    6779    0.642   687
+Ceres   939     0.939   1682
+Jupiter 139820  1898    4333
+Saturn  116460  568.3   10747
+Uranus  50724   86.8    30589
+Neptune 49244   102.0   59800
+Pluto   2377    0.0146  90560
+Makemake        1430            111845
+Haumea  1960            103658
+Eris    2326    0.167   204536
+```
+
+The same data formatted with `tsv2table`:
+
+```
+$ cat objects.tsv | tsv2table
+Name     | Diameter (km) | Mass (10^24 kg) | Orbital Period (days)
+------------------------------------------------------------------
+Sun      |       1392684 |    1989100      |
+Mercury  |          4880 |          0.330  |                 88
+Venus    |         12104 |          4.87   |                225
+Earth    |         12742 |          5.97   |                365.25
+Mars     |          6779 |          0.642  |                687
+Ceres    |           939 |          0.939  |               1682
+Jupiter  |        139820 |       1898      |               4333
+Saturn   |        116460 |        568.3    |              10747
+Uranus   |         50724 |         86.8    |              30589
+Neptune  |         49244 |        102.0    |              59800
+Pluto    |          2377 |          0.0146 |              90560
+Makemake |          1430 |                 |             111845
+Haumea   |          1960 |                 |             103658
+Eris     |          2326 |          0.167  |             204536
+```
+
+## Features
+
+ * Data Alignment: Automatically aligns data for clear readability and presentation
+ * Header Presence Detection: Intelligently detects the presence of headers in input data, enhancing table organization
+ * Custom Separator: Allows users to specify the separator character(s) for parsing data, providing flexibility in handling diverse file formats
+
 ## Installation
 
  * Download latest `tsv2table` from [Releases](https://github.com/bessarabov/tsv2table/releases)