@ivaniscoding/celq-linux-arm64 0.1.2-alpha.1 → 0.2.0-alpha.1

package/README.md

@@ -19,13 +19,13 @@ celq -n --arg='fruit:string=apple' 'fruit.contains("a")'
 # Outputs: true
 ```
 
-Closely related formats such as NDJSON and JSON5 are also supported.
+Popular configuration formats such as JSON5, YAML, and TOML are supported. The closely related format NDJSON is also supported.
 
 For detailed usage examples and recipes, see the [manual](https://docs.rs/celq/latest/celq/).
 
 ## Why?
 
-There are implementations of CEL for [Go](https://github.com/google/cel-go), [C++](https://github.com/google/cel-cpp), [Python](https://github.com/cloud-custodian/cel-python), [JavaScript](https://github.com/marcbachmann/cel-js), [Rust](https://github.com/cel-rust/cel-rust), and possibly more languages.
+There are implementations of CEL for [Go](https://github.com/google/cel-go), [Java](https://github.com/google/cel-java), [C++](https://github.com/google/cel-cpp), [JavaScript](https://github.com/marcbachmann/cel-js), [Python](https://github.com/cloud-custodian/cel-python), [C#](https://github.com/telus-oss/cel-net), [Rust](https://github.com/cel-rust/cel-rust), [Ruby](https://gitlab.com/os85/cel-ruby), and possibly more languages.
 
 `celq` brings the same CEL syntax to the command-line. `celq` is not necessarily better than jq, but perhaps it makes it easier to reuse snippets of code accross multiple places.
 
@@ -48,7 +48,7 @@ curl --proto '=https' --tlsv1.2 -sSf https://get-celq.github.io/install.sh | \
     bash -s -- --to DESTINATION
 ```
 
-See the the [installation guide](https://docs.rs/celq/latest/celq/) for more details on the installer such as `--force` to replace existing binaries, `--target` to specify which binary to download, versioned URLs, GitHub tokens, and more.
+See the the [installation guide](https://docs.rs/celq/latest/celq/installation_guide) for more details on the installer such as `--force` to replace existing binaries, `--target` to specify which binary to download, versioned URLs, GitHub tokens, and more.
 
 ### Homebrew (macOS)
 
@@ -57,12 +57,32 @@ If you are a [macOS Homebrew](https://brew.sh/) user, then you can install celq
 ```bash
 brew install get-celq/tap/celq
 ```
+
+### Chocolatey (Windows)
+
+If you are a [Chocolatey](https://community.chocolatey.org/) user on Windows, you can install `celq` with:
+
+```bash
+choco install celq
+```
+
+### Scoop (Windows)
+
+If you are a [Scoop](https://scoop.sh/) user on Windows, you can install `celq` with:
+
+```bash
+scoop bucket add get-celq https://github.com/get-celq/scoop-bucket
+scoop install get-celq/celq
+```
+
+### Cargo
+
 #### Installing From Source 
 
 If you want to install from source, celq publishes to [crates.io](https://crates.io/crates/celq).
 
 ```bash
-cargo install celq
+cargo install celq --locked
 ```
 
 #### Installing With cargo-binstall
@@ -100,9 +120,34 @@ This adds celq to `package.json` and makes it available for scripts. It's also p
 npx celq -n '"Hello World"'
 ```
 
+### GitHub Actions
+
+`celq` can be used in GitHub actions. For one-off commands, the [get-celq/celq-action](https://github.com/get-celq/celq-action) is the quickest way:
+
+```yaml
+- name: Example Celq Action
+  id: exampleID
+  uses: get-celq/celq-action@main
+  with:
+    cmd: celq 'this.exampleID' < example.json
+
+- name: Reuse a variable obtained in another step
+  run: echo ${{ steps.exampleID.outputs.result }}
+```
+
+See the [installation guide](https://docs.rs/celq/latest/celq/installation_guide) for more details on GitHub actions such as pinning the `celq` version and the Action itself.
+
+If you are going to use `celq` in scripts or for multiple calls, we recommend using [taiki-e/install-action](https://github.com/taiki-e/install-action):
+
+```yaml
+- uses: taiki-e/install-action@v2
+  with:
+    tool: celq
+```
+
 ## Limitations
 
-### JSON Parsing
+### Eager JSON Parsing
 
 `celq` eagerly parses all JSON input into memory before evaluation. This design was made to simplify the code implementation, at the cost of memory and performance.
 
@@ -112,7 +157,7 @@ Currently, there are no benchmarks for `celq`. I believe the tool is "good enoug
 
 `celq` uses [cel-rust](https://github.com/cel-rust/cel-rust), a community-maintained Rust implementation of CEL, rather than the official Go implementation. 
 
-While `cel-rust` provides excellent compatibility with the CEL specification, there may be edge cases or advanced features where behavior differs from the official implementation. If you find one, feel free to report it at their repository.
+There may be edge cases or advanced features where behavior differs from the official implementation. If you find one, open an issue at the celq repository and we'll triage the issue before sending it to cel-rust.
 
 ### List and Map Arguments
 
@@ -126,7 +171,7 @@ While conceptually interesting, `celq` does not aim to be a CEL REPL. In the ori
 
 ### Full YAML Support
 
-`celq` works with JSON. YAML will be supported in the future as a best-effort. Full YAML support is out-of-scope, as the specification has too many edge cases.
+`celq` works with JSON. YAML is supported as a best-effort. If the ingested YAML can be translated to JSON, `celq` most likely works fine. Full YAML support is out-of-scope, as the specification has too many edge cases.
 
 ## Acknowledgments
 

package/package.json

@@ -21,5 +21,5 @@
     "type": "git",
     "url": "git+https://github.com/IvanIsCoding/celq.git"
   },
-  "version": "0.1.2-alpha.1"
+  "version": "0.2.0-alpha.1"
 }