Skip to content

Commit 78982bd

Browse files
Merge pull request #25 from kate-goldenring/example-app-readme
Add README with prerequisites to example app
2 parents e3184ce + 45383f7 commit 78982bd

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
11
# Spin `command` Trigger
22

33
This is a very simple Spin trigger that executes the WASI main function.
4+
5+
## Installation
6+
7+
The trigger is installed as a Spin plugin. It can be installed from a release or build.
8+
9+
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:
10+
11+
```sh
12+
spin plugins install --from https://github.com/fermyon/spin-trigger-command/releases/download/canary/trigger-command.json
13+
```
14+
15+
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:
16+
17+
```sh
18+
spin plugins install pluginify
19+
cargo build --release
20+
spin pluginify install
21+
```

example/hello-world/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Hello World Command Spin App
2+
3+
## Prerequisites
4+
5+
1. Install [`cargo-component`](https://github.com/bytecodealliance/cargo-component) with a version that is compatible with WASI 0.2.0
6+
(at least `v0.7.0`).
7+
8+
## Running
9+
10+
```sh
11+
$ spin build --up
12+
Hello, world!
13+
```

0 commit comments

Comments
 (0)