From 5c0527061598a8b1db21b1e80c787f8a384cbe0f Mon Sep 17 00:00:00 2001
From: 0xar-ds <sadden-rope-sleek@duck.com>
Date: Wed, 17 Sep 2025 11:40:14 -0300
Subject: [PATCH] docs: update README for v2

---
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 45 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 03c52e5..0b70696 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,68 @@
 # appthrust/moon-ci-retrospect
 
-This action is designed for projects using Moonrepo, making the test results of the `moon ci` command more readable in GitHub Actions logs.
+This action is designed for projects using Moonrepo, making the test results of `moon ci` and `moon run` commands more readable in GitHub Actions logs.
 
-Typically, `moon ci` executes numerous tasks in parallel, which can make it difficult to view logs in task units. This results in lengthy logs, making it hard to pinpoint the cause of CI failures. This action aims to improve the readability of `moon ci` results, facilitating easier identification of the reasons for CI failures.
+Typically, a trigger of those commands executes numerous tasks in parallel, which can make it difficult to view logs in task units. This results in lengthy logs, making it hard to pinpoint the cause of CI failures. This action aims to improve the readability of `moon ci` and `moon run` results, facilitating easier identification of the reasons for CI failures.
 
 ![](./screenshot0.gif)
 
 | ![](./screenshot1.png) | ![](./screenshot2.png) |
-|------------------------|------------------------|
+| ---------------------- | ---------------------- |
 | ![](./screenshot3.png) | ![](./screenshot4.png) |
 
-
 ## Usage
 
+### On a CI workflow
+
 ```yaml
 jobs:
   ci:
     name: "CI"
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "actions/checkout@v4"
+      - name: "Checkout"
+        uses: "actions/checkout@v5"
         with:
           fetch-depth: 0
-      - uses: "moonrepo/setup-toolchain@v0"
-      - run: "moon ci --color"
+
+      - name: "Setup Toolchain"
+        uses: "moonrepo/setup-toolchain@v0"
+
+      - name: "Execute pipeline"
+        run: "moon ci"
+
       # Add this↓
-      - uses: appthrust/moon-ci-retrospect@v1
+
+      - name: "Collect/retrospect on results"
+        uses: "appthrust/moon-ci-retrospect@v2"
+        if: success() || failure()
+```
+
+### On any workflow that executes a task through Moon
+
+```yaml
+jobs:
+  ci:
+    name: "Release"
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v5"
+        with:
+          fetch-depth: 0
+
+      - name: "Setup Toolchain"
+        uses: "moonrepo/setup-toolchain@v0"
+
+      # Whatever you're doing on this workflow
+
+      - name: "Execute release pipeline"
+        run: "moon run root:publish-packages"
+
+      # Add this↓
+
+      - name: "Collect/retrospect on results"
+        uses: "appthrust/moon-ci-retrospect@v2"
         if: success() || failure()
 ```