Skip to content

Commit

Permalink
doc: Update the readme
Browse files Browse the repository at this point in the history
Inform about MacOS 14 arm64 support. Clean up the docker section.
Move `cargo-binstall` to the "Pre-built binary" section.
Mention the web ui in "Getting Started".
  • Loading branch information
tomasol committed Jan 16, 2025
1 parent ec909d3 commit a29be11
Showing 1 changed file with 13 additions and 17 deletions.
30 changes: 13 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,30 +52,26 @@ Deterministic workflow engine built on top of the WASM Component Model.

## Installation
### Supported platforms
* Linux x64 - musl or glibc v2.35+
* Mac OS 13 x64
* Linux x64 - musl, glibc v2.35+, NixOS
* MacOS 13 x64
* MacOS 14 arm64

### Docker
```sh
CONTAINER_ID=$(docker run -d getobelisk/obelisk)
docker logs --follow $CONTAINER_ID | grep "Serving gRPC requests"
```
```sh
docker exec $CONTAINER_ID obelisk client component list
# See Usage for more details
docker run --net=host getobelisk/obelisk
```

### Pre-built binary
Download [latest release](https://github.com/obeli-sk/obelisk/releases/latest) from the GitHub Release page.
Or if [cargo-binstall](https://crates.io/crates/cargo-binstall) is available:
```sh
cargo binstall obelisk
```

### Compiling from source
The compilation requires `protoc` [Protocol Buffers compiler](https://protobuf.dev/downloads/).

#### Using latest version from crates.io
Download using [cargo-binstall](https://crates.io/crates/cargo-binstall)
```sh
cargo binstall --locked obelisk
```
or build using [cargo](https://rustup.rs/)
```sh
cargo install --locked obelisk
Expand Down Expand Up @@ -107,17 +103,17 @@ obelisk server generate-config
obelisk server run
```

### Getting the list of loaded functions
### Using the CLI client
```sh
obelisk client component list
```

### Submitting a function to execute (either workflow or activity)
```sh
# Call fibonacci(10) activity from the workflow 500 times in series.
obelisk client execution submit testing:fibo-workflow/workflow.fiboa '[10, 500]' --follow
```

### Using the Web UI
Navigate to [localhost:8080](http://127.0.0.1:8080). The UI shows list of comopnents with functions that
can be submitted, as well as execution history.

# Contributing
This project has a [roadmap](ROADMAP.md) and features are added in a certain order.
If you would like to contribute a feature, please [discuss](https://github.com/obeli-sk/obelisk/discussions) the feature on GitHub.
Expand Down

0 comments on commit a29be11

Please sign in to comment.