From 96a30723b16b2dc43e35e74aa7c35ebaf1965cae Mon Sep 17 00:00:00 2001 From: andrewhassan Date: Thu, 26 May 2022 13:38:01 -0400 Subject: [PATCH] Update README to include releases link --- Cargo.lock | 2 +- README.md | 34 +++++++++++----------------------- 2 files changed, 12 insertions(+), 24 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 4be7a6b0..09bbbf0a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -533,7 +533,7 @@ dependencies = [ [[package]] name = "function-runner" -version = "0.2.3" +version = "3.0.0" dependencies = [ "anyhow", "clap", diff --git a/README.md b/README.md index 5e51d8b8..468fc392 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # function-runner -[About this repo](#about-this-repo) | [Commands](#commands-optional) | [How to use this repo](#how-to-use-this-repo) +[About this repo](#about-this-repo) | [Usage](#usage) | [Development](#development) ## About this repo + **Introduction:** This is a simple CLI (`function-runner`) which allows you to run Wasm @@ -15,32 +16,19 @@ current directory. This may be overriden using the `-f` option. Example: `function-runner -f '../my-function-name.wasm' '../my-input.json'` -## Commands (optional) +## Usage + +If you wish to use `function-runner` without compiling it, the [Releases](https://github.com/Shopify/function-runner/releases) page +contains binaries that can be run on your computer. -* `cargo install --path .` : Build and install the `function-runner` command. -* `function-runner` : Execute Functions. +To see the list of possible commands and arguments, run `function-runner --help`. -## How to use this repo +## Development Building requires a rust toolchain of at least `1.56.0` (older may work). `cargo install --path .` will build and add the `function-runner` command to your path. -### Usage - -``` -$ function-runner --help -function-runner 3.0.0 -Simple function runner which takes JSON as a convenience - -USAGE: - function-runner [OPTIONS] - -ARGS: - Path to json file containing function input +### Commands -OPTIONS: - -h, --help Print help information - -j, --json Log the run result as a JSON object - -f, --function Path to wasm/wat function [default: function.wasm] - -V, --version Print version information -``` +- `cargo install --path .` : Build and install the `function-runner` command. +- `function-runner` : Execute a Function.