chore: bump crates and docs (#3)

* feat: update peer deps

* feat: bump crates

* bump version in README

* feat: update docs

* fix: fix commands

Author: QEDK

.github/workflows/release.yml

@@ -140,7 +140,7 @@ jobs:
         uses: docker/build-push-action@v6
         with:
           push: true
-          platforms: linux/amd64,linux/arm64
+          platforms: linux/arm64
           sbom: true
           provenance: mode=max
           tags: ${{ steps.meta.outputs.tags }}

Cargo.lock

@@ -2,16 +2,16 @@
 name = "soteria"
 authors = ["QEDK <qedk@monad.foundation>"]
 license = "Apache-2.0"
-version = "0.1.6"
+version = "0.1.7"
 edition = "2024"
 
 [dependencies]
 # anyhow should not be pinned
 anyhow = "1"
-clap = { version = "=4.5.51", features = ["derive"] }
+clap = { version = "=4.5.53", features = ["derive"] }
 hex = "=0.4.3"
 owo-colors = "=4.2.3"
-primitive-types = "=0.12.2"
+primitive-types = "=0.14.0"
 # serde should not be pinned
 serde = { version = "1", features = ["derive"] }
 # serde_json should not be pinned

Cargo.toml

@@ -1,20 +1,59 @@
 # 🚦 soteria 
-A simple CLI tool that validates Safe transaction hashes in JSON log files.
+A simple CLI tool that validates Safe transaction hashes in JSON log files. This is
+a metarepo that contains the CLI tool, a GitHub action, and a Docker image for easy integration into various workflows.
 
 ## Quickstart
 
-### Using CLI
+### Install from source
+To install soteria from source, ensure you have Rust and Cargo installed. Then, you can use the CLI tool as follows:
 ```bash
 cargo install --git https://github.com/monad-developers/soteria.git
 soteria /path/to/your/logs/directory
 ```
 
+### Build and install from source
+To build soteria from source, ensure you have Rust and Cargo installed. Then, clone the repository and build the project:
+```bash
+git clone https://github.com/monad-developers/soteria.git
+cd soteria
+cargo install --path .
+soteria /path/to/your/logs/directory
+```
+
+### Using GitHub Actions
+If you want to integrate soteria into your CI/CD pipeline, you can use the GitHub action:
+```yaml
+- name: Run soteria
+  id: soteria
+  uses: monad-developers/soteria-action@v0.1.7
+  with:
+    directory: '/path/to/your/logs/directory'
+```
+
+A full list of available flags for the GitHub action is provided below:
+| Input           | Required? | Default  | Description                          |
+|-----------------|-----------|----------|--------------------------------------|
+| `directory`     | Yes       | N/A      | Directory containing log files.      |
+| `version`       | No        | `latest` | Version of soteria to use.           |
+| `github-token`  | No        | N/A      | GitHub token for authentication.     |
+| `fail-on-error` | No        | `true`   | Whether to fail the action on error. |
+
 ### Using Docker
+You can also run soteria using Docker. There are two options: using a pre-built image or building the image from source. Images use statically linked binaries and are run in a minimal non-root environment for security.
+
+#### Pre-built image
+```bash
+docker pull monadfoundation/soteria
+```
+
+#### Build from source
 ```bash
+git clone https://github.com/monad-developers/soteria.git
+cd soteria
 docker build -t soteria .
 ```
 
-Replace `$(pwd)/src/mocks` with your directory of files to check:
+#### Run the image
 ```bash
-docker run -v $(pwd)/src/mocks:/mnt/data soteria /mnt/data
+docker run -v <path-to-your-logs>:/mnt/data soteria /mnt/data
 ```

README.md

@@ -489,7 +489,8 @@ fn encode_address(address: [u8; 20]) -> [u8; 32] {
 
 fn encode_u256(value: U256) -> [u8; 32] {
     let mut out = [0u8; 32];
-    value.to_big_endian(&mut out);
+    let bytes = value.to_big_endian();
+    out.copy_from_slice(&bytes);
     out
 }