fix,docs: component building and running, add instructions to README

dylibso · Jan 25, 2024 · fa29a81 · fa29a81
1 parent 0652bfe
commit fa29a81
Show file tree

Hide file tree

Showing 9 changed files with 337 additions and 1,344 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/README.md b/README.md
@@ -138,3 +138,33 @@ One of the test adapters will output to Zipkin, defaulting to one running on
 localhost.
 
     docker run -d -p 9411:9411 openzipkin/zipkin
+
+## Component Support
+
+WIT is available in `wit` for the (manual) observe api and (automatic) observe instrument api.
+
+### Examples
+
+First install dependencies:
+
+```bash
+cargo install wasm-tools cargo-component
+```
+
+Build the wit:
+
+```bash
+just build_wit
+```
+
+Build and run `component_demo`:
+
+```bash
+just component_demo
+```
+
+Build and run `component_demo_2`:
+
+```bash
+just component_demo_2
+```