anthony/csv2md
1
0
Fork 0
mirror of https://github.com/anthonyaxenov/csv2md.git synced 2024-11-22 05:14:57 +00:00
Code Issues Releases Activity

Update readme

Browse Source
This commit is contained in:
Anthony Axenov 2022-02-17 13:12:11 +08:00
parent f1aa5d3eff
commit e7f8f3e3ad
Signed by: anthony
GPG Key ID: EA9EC32FF7CCD4EC
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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 . <csv_path>` to build and run temporary binary.
## License