diff --git a/README.md b/README.md index 8c624ae..ed5ca8e 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,27 @@ Stupidly simple tool to convert csv-file to [markdown](https://spec-md.com/) tab Outputs result in stdout. -Building: +## Usage ```shell -make help -``` +csv2md example.csv > example.md # save result to new file +csv2md example.csv | less # view result using pager -Usage: - -```shell -csv2md example.csv > example.md # makes new file -csv2md example.csv | less # view result using *pager* ...anything is possible with redirection and piping ``` -> **IMPORTANT:** input must be valid csv and whitespaces are allowed only between double-quotes. +> **IMPORTANT:** +> * input file 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 + +## Compilation + +1) [Install go](https://go.dev/learn/). +2) Clone this repo. +3) Run `make help` to get help or `go run . ` to build and run temporary binary. + +## License + +[MIT](LICENSE)