Update documentation

ros2wasm · Sep 19, 2023 · ed821c4 · ed821c4
1 parent 5f1ee1a
commit ed821c4
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,14 @@
-# workflows
+# ROS2WASM Builder
+
+This action cross-compiles a ROS 2 package to WebAssembly and uploads the built files as artifacts.
+
+## Usage
+
+```yaml
+- steps:
+    uses: actions/ros2wasm-builder@v1
+    with:
+        package: 'the_target_package'
+        ros_distro: 'humble'
+        debug_mode: false
+```
diff --git a/action.yml b/action.yml
@@ -1,5 +1,8 @@
 name: ros2wasm-builder
 description: "Cross-compiles ROS 2 packages to WASM"
+branding:
+  icon: "box"
+  color: "yellow"
 
 inputs:
   package: