Skip to content

Commit

Permalink
Retouch README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
magicdrive committed Nov 2, 2024
1 parent ed7d95d commit 49e4acb
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,16 @@ Receives a JSON string and outputs it as a Golang struct definition.
### Options

Option | Description | Default
-------------------------------- | -------------------------------------------------------------------------------- | ---------------
---------------------------------- | -------------------------------------------------------------------------------- | ---------------
`-h`, `--help` | Show this help message and exit |
`-v`, `--version` | Show version and exit |
`-n`, `--name <root-name>` | Specify the name of the root struct. Converts to camel case automatically. | `AutoGenerated`
`-f`, `--file <json-file>` | Specify the input file containing JSON. Accepts files without `.json` extension. |
`-a`, `--null-as <null-type-name>` | Specify the null-type name. Used to replace `null` type from json. | `interface{}`
`-j`, `--json <json-string>` | Specify the JSON string to be converted to a struct. |
`-p`, `--pipe` | Receive JSON from a pipe instead of a direct argument above all else. | `false`
`--pointer` `<on|off>` | Define struct and array fields as pointers. | `off`
`--pager` `<pager-mode(auto|no)>` | Prevents usage of a pager even if output exceeds terminal size. (auto|no) | `auto`
`--pointer` `<on\|off>` | Define struct and array fields as pointers. | `off`
`--pager` `<pager-mode(auto\|no)>` | Prevents usage of a pager even if output exceeds terminal size. (auto\|no) | `auto`
`--outline` | Defines struct and array fields as outline struct. (default: true). | `true`
`--inline` | Defines struct and array fields as inline struct. (default: false) | `false`

Expand All @@ -68,7 +68,7 @@ Option | Description
### Environments

Environment | Description | Default
-------------------------------- | ----------------------------------------------------------------------------------- | ---------------
---------------------------------- | ----------------------------------------------------------------------------------- | ---------------
`KIRKE_DEFAULT_ROOT_NAME` | Specified default used `<root-name>`. | `AutoGenerated`
`KIRKE_DEFAULT_NULL_AS` | Specified default used `<null-type-name>`. | `interface{}`
`KIRKE_DEFAULT_OUTPUT_MODE` | Specified the default used output mode. Only `outline` and `inline` are valid. | `outline`
Expand Down

0 comments on commit 49e4acb

Please sign in to comment.