From 0fd1a5f79b6ca0098ed90ab79080b521ebb4e233 Mon Sep 17 00:00:00 2001
From: gowthaman <gowthaman@365build.in>
Date: Sat, 17 Jun 2023 23:59:02 +0530
Subject: [PATCH] update readme

---
 README.md | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

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 <dir of input json>`
   * required `--output <dir of output csvs>`
@@ -14,6 +15,12 @@ Steps
   * (optional) # of records to check records for all headers `--metadata <number or records>` defaults to 1000
   * required `--join-column <column name from first level to use as merge column>`
   * required `--name <base-name of data>`
-* 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')"`