diff --git a/README.md b/README.md index 7d3344e..676b227 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,10 @@ JSON to CSV with support for nested structures (with auto schema) -Steps - +## Install * install required packages `pip install -r requirements.txt` + +## Steps * run `python3 main.py` * required `--input ` * required `--output ` @@ -14,6 +15,12 @@ Steps * (optional) # of records to check records for all headers `--metadata ` defaults to 1000 * required `--join-column ` * required `--name ` -* example - * `python3 main.py --input /var/tmp/input --output /var/tmp/outputs --name transactions --single --metadata 1000 --join-column origin_id` + +## examples + * default with | as delimiter + * `python3 main.py --input /var/tmp/input --output /var/tmp/outputs --name transactions --single --metadata 1000 --join-column origin_id` + * use comma (,) as delimiter + * `python3 main.py --input /var/tmp/input --output /var/tmp/outputs --name transactions --single --metadata 1000 --join-column origin_id --delimiter ","` + * use tab (\t) as delimiter + * `python main.py --input /var/tmp/input --output /var/tmp/output --single --metadata 1000 --join-column origin_id --name oopsy --delimiter "$(echo -en '\t')"`