add some docs

This commit is contained in:
2023-02-13 12:40:56 +11:00
parent 78ba74c709
commit 061bb83861
2 changed files with 16 additions and 7 deletions

View File

@@ -5,6 +5,12 @@ This is a basic utility to take json and convert it into an OpenXml format xlsx
It expects that the json input is formatted as an object containing an array of objects. Column names are generated based on the keys in the first nested object.
## Command line options
| Parameter | Default Value | Description
|---------------|---------------|
| worksheetName | Sheet1 | Set the name of the worksheet
| Parameter | Default Value | Description |
|---------------|---------------|---------------------------|
| inputJson | input.json | File path of the input json to process |
| outputFilename | output.xlsx | File path of the output file |
| worksheetName | Sheet1 | Set the name of the worksheet |
| boldTopRow | true | Sets the top row of the worksheet to bold |
| freezeTopRow | true | Freezes the first row of the Excel worksheet |
| autofilter | true | Sets the auto filter on the first row |
| autowidth | true | Automatically set the column width to fit contents |