Skip to content

Commit

Permalink
Adds README for code generation (#178)
Browse files Browse the repository at this point in the history
* Adds README for code generator
* Add reference to code generation user guide
* Adds changes to CLI option for --authority option
  • Loading branch information
desaikd authored Nov 5, 2024
1 parent 3f25f22 commit 5b292fa
Show file tree
Hide file tree
Showing 3 changed files with 588 additions and 6 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ for working with [the Ion data format](https://amzn.github.io/ion-docs/docs/spec
* [Converting between Ion formats](#converting-between-ion-formats)
* [Converting between Ion and other formats with `to` and
`from`](#converting-between-ion-and-other-formats-with-to-and-from)
* [Ion code generation](#ion-code-generation)
* [Analyzing binary Ion file encodings with `inspect`](#analyzing-binary-ion-file-encodings-with-inspect)
* [Installation](#installation)
* [via `brew`](#via-brew)
* [via `cargo`](#via-cargo)
* [Installing experimental subcommand for code generation](#installing-experimental-subcommand-for-code-generation)
* [Build Instructions](#build-instructions)
* [From source](#from-source)
* [Using Docker](#using-docker)
Expand Down Expand Up @@ -84,6 +84,12 @@ Convert JSON to Ion:
ion from -X json my_file.json
```

### Ion Code generation

Code generation is supported with `generate` subcommand on the CLI.
For more information on how to use code generator,
see [Ion code generator user guide](https://github.com/amazon-ion/ion-cli/tree/main/src/bin/ion/commands/generate/README.md).

### Analyzing binary Ion file encodings with `inspect`

The `inspect` command can display the hex bytes of a binary Ion file alongside
Expand Down
Loading

0 comments on commit 5b292fa

Please sign in to comment.