Skip to content

Commit 3f25f22

Browse files
authored
Removes unnecessary section from README (#176)
1 parent 42f5911 commit 3f25f22

File tree

1 file changed

+5
-46
lines changed

1 file changed

+5
-46
lines changed

README.md

Lines changed: 5 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,11 @@ brew tap amazon-ion/ion-cli
165165
brew install ion-cli
166166
```
167167

168+
To install the (potentially unstable) latest changes from the tip of `main` rather than the latest release, use:
169+
```bash
170+
brew install ion-cli --HEAD
171+
```
172+
168173
### via `cargo`
169174

170175
The `ion-cli` can also be installed by using Rust's package manager, `cargo`.
@@ -177,52 +182,6 @@ To install `ion-cli`, run the following command:
177182
cargo install ion-cli
178183
```
179184

180-
### Installing experimental subcommand for code generation
181-
182-
If you are looking into accessing all features with `brew` (including `experimental` features, currently only
183-
includes `generate`
184-
subcommand) of `ion-cli`, run:
185-
186-
```bash
187-
brew install ion-cli --HEAD
188-
```
189-
190-
Then make sure that `~/.cargo/bin` is on your `$PATH`. You can confirm that it
191-
has been installed successfully by running:
192-
193-
```shell
194-
ion help
195-
```
196-
197-
You should see output that resembles the following:
198-
199-
```
200-
A collection of tools for working with Ion data.
201-
202-
Usage: ion [OPTIONS] <COMMAND>
203-
204-
Commands:
205-
cat Prints all Ion input files to the specified output in the requested format.
206-
count (UNSTABLE) Prints the number of top-level values found in the input stream.
207-
from 'from' is a namespace for commands that convert other data formats to Ion.
208-
generate (UNSTABLE) Generates code using given schema file.
209-
head Prints the specified number of top-level values in the input stream.
210-
inspect Displays hex-encoded binary Ion alongside its equivalent text Ion.
211-
Its output prioritizes human readability and is likely to change
212-
between versions. Stable output for programmatic use cases is a
213-
non-goal.
214-
primitive (UNSTABLE) Prints the binary representation of an Ion encoding primitive.
215-
schema The 'schema' command is a namespace for commands that are related to Ion Schema.
216-
symtab 'symtab' is a namespace for commands that operate on symbol tables
217-
to 'to' is a namespace for commands that convert Ion to another data format.
218-
help Print this message or the help of the given subcommand(s)
219-
220-
Options:
221-
-h, --help Print help
222-
-V, --version Print version
223-
-X, --unstable Opt in to using an unstable feature of Ion CLI.
224-
```
225-
226185
## Build instructions
227186

228187
### From source

0 commit comments

Comments
 (0)