Skip to content

Commit 042a7b3

Browse files
committed
Doc improvements
1 parent 543f796 commit 042a7b3

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

docs/installation_guide.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,8 @@ By default, the installer always chooses Linux binaries that are the most portab
219219

220220
It is worth highlighting that if no `--to` flag is specified, the installer tries to write `$CARGO_HOME/bin/celq`, `$HOME/.cargo/bin/celq`, `$HOME/.local/bin/celq` in that order. If a directory does not exist, the installer moves to the next guess. `$HOME/bin` is the final destination if none of directories exist. If the directory that `celq` was installed is not in the path, the installer will warn the user.
221221

222+
Although unusual, the installer probably works for Windows in Git Bash (MSYS2) and Cygwin. It will detect the platform correctly and download the binaries. As of today, we do not have a Power Shell installer yet, so this option could be interesting for Windows users that do not have Chocolatey/Scoop available.
223+
222224
## Acknowledgments
223225

224226
Special thanks to the maintainers of:

docs/manual.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ Also works as a way to output `"AAPL"` in the command, just like in the first ex
305305

306306
### JSON5 Support
307307

308-
`celq` also supports [JSON5](https://json5.org/), a popular JSON extension among config files. It also indirectly supports [JSONC](https://jsonc.org/), because JSON5 is a superset of JSONC but don't quote me on that.
308+
`celq` supports [JSON5](https://json5.org/), a popular JSON extension among config files. It also indirectly supports [JSONC](https://jsonc.org/), because JSON5 is a superset of JSONC but don't quote me on that.
309309

310310
To enable the JSON5 parser, pass the `--from-json5` flag. For example:
311311

@@ -319,7 +319,7 @@ Notice that passing the `--from-json5` clashes with the `--slurp` flag and with
319319

320320
### TOML Support
321321

322-
`celq` also supports [TOML](https://toml.io/en/), another popular configuration format. For example, `celq` can query it's own manifest file:
322+
`celq` supports [TOML](https://toml.io/en/), another popular configuration format. For example, `celq` can query it's own manifest file:
323323

324324
```bash
325325
celq --from-toml 'this.package.version' < Cargo.toml
@@ -329,7 +329,7 @@ The output is `celq`'s development version.
329329

330330
### YAML Support
331331

332-
`celq` also supports [YAML](https://yaml.org/), another popular configuration format. For example, `celq` can query [CEL expressions commonly defined in YAML files](https://web.archive.org/web/20251108093453/https://blog.howardjohn.info/posts/cel-is-good/) and evaluate them!
332+
`celq` supports [YAML](https://yaml.org/), another popular configuration format. For example, `celq` can query [CEL expressions commonly defined in YAML files](https://web.archive.org/web/20251108093453/https://blog.howardjohn.info/posts/cel-is-good/) and evaluate them!
333333

334334
Take for example `config.yaml` with:
335335

0 commit comments

Comments
 (0)