From ed821c4eec49bdd1d71b43d8c8272f70899cdb89 Mon Sep 17 00:00:00 2001
From: Isabel Paredes <isabel.paredes@quantstack.net>
Date: Tue, 19 Sep 2023 14:28:56 +0200
Subject: [PATCH] Update documentation

---
 README.md  | 15 ++++++++++++++-
 action.yml |  3 +++
 2 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1a17e2e..4a926ec 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
-# workflows
\ No newline at end of file
+# 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
index d29030a..147e700 100644
--- 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: