-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from kate-goldenring/example-app-readme
Add README with prerequisites to example app
- Loading branch information
Showing
2 changed files
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,21 @@ | ||
# Spin `command` Trigger | ||
|
||
This is a very simple Spin trigger that executes the WASI main function. | ||
|
||
## Installation | ||
|
||
The trigger is installed as a Spin plugin. It can be installed from a release or build. | ||
|
||
To install from a release, reference a plugin manifest from a [release](https://github.com/fermyon/spin-trigger-command/releases). For example, to install the canary release: | ||
|
||
```sh | ||
spin plugins install --from https://github.com/fermyon/spin-trigger-command/releases/download/canary/trigger-command.json | ||
``` | ||
|
||
Alternatively, use the `spin pluginify` plugin to install from a fresh build. This will use the pluginify manifest (`spin-pluginify.toml`) to package the plugin and proceed to install it: | ||
|
||
```sh | ||
spin plugins install pluginify | ||
cargo build --release | ||
spin pluginify install | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Hello World Command Spin App | ||
|
||
## Prerequisites | ||
|
||
1. Install [`cargo-component`](https://github.com/bytecodealliance/cargo-component) with a version that is compatible with WASI 0.2.0 | ||
(at least `v0.7.0`). | ||
|
||
## Running | ||
|
||
```sh | ||
$ spin build --up | ||
Hello, world! | ||
``` |