diff --git a/README.md b/README.md index ed5ca8e..4932359 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,22 @@ Outputs result in stdout. ## Usage ```shell -csv2md example.csv > example.md # save result to new file -csv2md example.csv | less # view result using pager +csv2md (-h|-help|--help|help) # to get this help +csv2md example.csv # convert data from file and write result in stdout +csv2md < example.csv # convert data from stdin and write result in stdout +cat example.csv | csv2md # convert data from stdin and write result in stdout +csv2md example.csv > example.md # convert data from file and write result in new file +csv2md example.csv | less # convert data from file and write result in stdout using pager +csv2md # paste or type data to stdin by hands + # press Ctrl+D to view result in stdout +csv2md > example.md # paste or type data to stdin by hands + # press Ctrl+D to write result in new file ...anything is possible with redirection and piping ``` > **IMPORTANT:** -> * input file must be valid csv +> * input must be valid csv > * whitespaces allowed only between double-quotes Examples can be found here: https://people.sc.fsu.edu/~jburkardt/data/csv/csv.html @@ -22,7 +30,7 @@ Examples can be found here: https://people.sc.fsu.edu/~jburkardt/data/csv/csv.ht ## Compilation 1) [Install go](https://go.dev/learn/). -2) Clone this repo. +2) Download this repo via zip or `git clone`. 3) Run `make help` to get help or `go run . ` to build and run temporary binary. ## License