Update readme with new GH integration

devlooped · Jul 4, 2024 · 59d6c74 · 59d6c74
1 parent 090e2ee
commit 59d6c74
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/assets/img/comment.png b/assets/img/comment.png
diff --git a/readme.md b/readme.md
@@ -13,6 +13,22 @@ Pretty-print test results in TRX format.
 
 Typical usage: `dotnet test --logger trx; trx` (optionally with `--output`).
 
+It automatically integrates with GitHub Actions by appending a pull request comment with the results too.
+Set up workflow with:
+
+```yml
+    - name: 🧪 show
+      if: always()
+      run:  
+        dotnet tool update -g dotnet-trx
+        trx --output
+```
+
+And view results in an automatic pull request comment like:
+
+![PR comment](https://raw.githubusercontent.com/devlooped/dotnet-trx/main/assets/img/comment.png)
+
+
 ```shell
 USAGE:
     trx [OPTIONS]