document how to quickly get started with a local cluster (#11)

Author: devigned

README.md

@@ -3,6 +3,9 @@ This project aims to provide containerd shim implementations that can run Wasm /
 
 [runwasi](https://github.com/deislabs/runwasi) is a project that aims to run wasm workloads running on [Wasmtime](https://wasmtime.dev/), a fast and secure runtime for WebAssembly, which is managed by containerd.
 
+## Quickstart
+To get up and running quickly on a local k3d cluster, use [the k3d deployment described here](./deployments/k3d/README.md#how-to-run-the-example).
+
 ## Containerd Wasm Shims
 Each of the shims below leverage runwasi to provide the bridge between K8s and containerd. 
 

deployments/k3d/README.md

@@ -14,7 +14,21 @@ $ tree .
 - **Dockerfile:** is the specification for the image run as a Kubernetes node within the k3d cluster. We add the shims to the `/bin` directory and add the containerd config in the k3s prescribed directory.
 - **Makefile**: has some helpful tasks to aid in execution.
 
-## How to use this example
+## How to run the example
+The shell script below will create a k3d cluster locally with the Wasm shims installed and containerd configured. The script then applies the runtime classes for the shims and an example service and deployment. Finally, we curl the `/hello` and receive a response from the example workload.
+```shell
+k3d cluster create wasm-cluster --image ghcr.io/deislabs/containerd-wasm-shims/examples/k3d:latest --api-port 6550 -p "8081:80@loadbalancer"
+kubectl apply -f https://github.com/deislabs/containerd-wasm-shims/releases/download/v0.2.0/runtime.yaml
+kubectl apply -f https://github.com/deislabs/containerd-wasm-shims/releases/download/v0.2.0/workload.yaml
+curl -v http://0.0.0.0:8081/hello
+```
+
+To tear down the cluster, run the following.
+```shell
+k3d cluster delete wasm-cluster
+```
+
+## How build get started from source
 - `make install-k3d`: will install k3d
 - `make up`: will build the shims and the k3d kubernetes cluster
 - `make deploy`: will deploy our runtime classes, services, and deployments of Wasm workloads. You can find these manifests in [the workloads directory](../workloads).