diff --git a/README.md b/README.md index 1fa79391..4a5f1efb 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,16 @@ The Arcaflow Engine allows you to run workflows using container engines, such as Docker or Kubernetes. The plugins must be built with the [Arcaflow SDK](https://arcalot.io/arcaflow/creating-plugins/python/). +## Pre-built binaries + +If you want to use our pre-built binaries, you can find them in the [releases section](https://github.com/arcalot/arcaflow-engine/releases). + ## Building from source This system requires at least Go 1.18 to run and can be built from source: ``` -go build cmd/arcaflow/main.go +go build -o arcaflow cmd/arcaflow/main.go ``` This binary can then be used to run Arcaflow workflows. @@ -50,7 +54,7 @@ name: Arca Lot If you have a local Docker / Moby setup installed, you can run it immediately: ``` -arcaflow -input input.yaml +./arcaflow -input input.yaml ``` If you don't have a local Docker setup, you can also create a `config.yaml` with the following structure: