Skip to content

Commit a3d6691

Browse files
committed
docs: add more to the readme
the current readme does not provide information regarding documentation, feedback and contribution guide. This commit adds these crucial information to make the repo more developer friendly Signed-off-by: jiaxiao zhou <[email protected]>
1 parent 50e8492 commit a3d6691

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Containerd Shim Spin
22

3-
This project aims to provide the containerd shim implementation for [Spin](https://developer.fermyon.com/spin), which enables running Spin workloads on Kubernetes via [runwasi](https://github.com/deislabs/runwasi). This means that by installing this shim onto Kubernetes nodes, we can add a [runtime class](https://kubernetes.io/docs/concepts/containers/runtime-class/) to Kubernetes and schedule Spin workloads on those nodes. Your Spin apps can act just like container workloads!
3+
This project aims to provide the [containerd shim](https://github.com/containerd/containerd/blob/main/core/runtime/v2/README.md#runtime-shim) implementation for [Spin](https://developer.fermyon.com/spin), which enables running Spin workloads on Kubernetes via [runwasi](https://github.com/deislabs/runwasi). This means that by installing this shim onto Kubernetes nodes, we can add a [runtime class](https://kubernetes.io/docs/concepts/containers/runtime-class/) to Kubernetes and schedule Spin workloads on those nodes. Your Spin apps can act just like container workloads!
44

55
[runwasi](https://github.com/deislabs/runwasi) is a project that aims to run WASI workloads managed by [containerd](https://containerd.io/).
6+
7+
## Documentation
8+
9+
To learn more about the Containerd Shim Spin, please visit [the official Containerd Shim Spin documentation](https://www.spinkube.dev/docs/containerd-shim-spin/).
10+
11+
## Feedback
12+
13+
For questions or support, please visit our [Slack channel](https://cloud-native.slack.com/archives/C06PC7JA1EE): #spinkube.
14+
15+
## Contributing
16+
17+
If you would like to contribute, please visit this [contributing](https://www.spinkube.dev/docs/containerd-shim-spin/contributing/) page.

0 commit comments

Comments
 (0)