Go to file
Radu Matei 9869be2045
docs: add package.json file to watch for changes in docs website
Signed-off-by: Radu Matei <radu.matei@fermyon.com>
2022-03-09 04:39:05 +02:00
.cargo chore: rename fermyon-* to spin-* 2021-11-29 19:12:45 -08:00
.devcontainer build[#138]: add vscode dev container support 2022-03-07 19:39:30 +00:00
.github/workflows chore: add GitHub Action for Rust caching 2022-03-05 23:42:19 +02:00
.vscode docs: add initial documentation for Spin and minor cleanup 2022-03-07 19:11:40 +02:00
crates chore: update Wagi revision 2022-03-09 00:48:46 +02:00
docs docs: add package.json file to watch for changes in docs website 2022-03-09 04:39:05 +02:00
sdk/rust docs: add initial documentation for Spin and minor cleanup 2022-03-07 19:11:40 +02:00
src ref(feat-33): TLS support for Spin. 2022-03-02 09:52:28 -07:00
templates/spin-http fix: fix template spin.toml 2022-03-07 21:39:17 +02:00
tests fix(tests): fix wrong timeout in integration test 2022-03-05 17:11:51 +02:00
wit/ephemeral Add interfaces for triggers and the WASI toolkit in wasi/ephemeral 2022-01-26 05:16:57 +02:00
.gitignore docs: add package.json file to watch for changes in docs website 2022-03-09 04:39:05 +02:00
Cargo.lock chore: update Wagi revision 2022-03-09 00:48:46 +02:00
Cargo.toml chore: clean comments and organize imports 2022-03-07 18:53:57 +02:00
LICENSE Add Apache2 license 2021-11-01 19:16:52 -07:00
Makefile ref(feat-33): TLS support for Spin. 2022-03-02 09:52:28 -07:00
build.rs tests: add integration tests 2022-03-01 17:22:02 +02:00
readme.md docs: add initial documentation website based on Bartholomew 2022-03-09 02:18:00 +02:00

readme.md

Spin

Spin is a framework for building, deploying, and running fast, secure, and composable cloud microservices with WebAssembly.

What is Spin?

Spin is an open source framework for building and running fast, secure, and composable cloud microservices with WebAssembly. It aims to be the easiest way to get started with WebAssembly microservices, and takes advantage of the latest developments in the WebAssembly component model and Wasmtime runtime.

Spin offers a simple CLI that helps you create, distribute, and execute applications, and in the next sections we will learn more about Spin applications and how to get started.

Getting started

See the quickstart document for a detailed guide on configuring Spin and writing your first Spin application, but in short:

$ wget https://github.com/fermyon/spin/releases/download/canary/spin-canary-<os-arch>.tar.gz
$ tar xfv spin-canary-<os-arch>.tar.gz
$ ./spin --help

After you follow the quickstart document, you can follow the guide on writing HTTP applications with Spin and the guide on configuring Spin applications.

After you built your application, run it using Spin, pointing to the Spin application configuration file:

$ spin up --file spin.toml

Contributing

We are delighted that you are interested in making Spin better! Thank you! Please follow the contributing guide.