From e8283632a14dd4da447e4ac1fd0168de749559ef Mon Sep 17 00:00:00 2001
From: Dou Du <56022756+dou-du@users.noreply.github.com>
Date: Thu, 13 Jun 2024 11:30:03 +0800
Subject: [PATCH] Update README.md

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index ab52070..f585a50 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,19 @@ This will
 - update version numbers, make a corresponding `git commit` and a `git tag`;
 - push this commit and tag to Github, which triggers the Github Action that makes a new Github Release and publishes the package to PYPI.
 
+### Github workflow testing
+
+[![widget test](https://github.com/osscar-org/widget-bzvisualizer/actions/workflows/widget-test.yml/badge.svg)](https://github.com/osscar-org/widget-bzvisualizer/actions/workflows/widget-test.yml)
+
+If the `widget test` fails, it indicates there is something wrong with the code, and the widget is NOT
+being displayed correctly in the test.
+
+[![screenshot comparison](https://github.com/osscar-org/widget-bzvisualizer/actions/workflows/screenshot-comparison.yml/badge.svg)](https://github.com/osscar-org/widget-bzvisualizer/actions/workflows/screenshot-comparison.yml)
+
+If the `widget test` passes but the `screenshot comparison` fails, it indicates the appearance of the widget 
+is different from the previous version. In this case, you'll need to manually download the artifact from 
+the `widget test` and use it to replace the `widget-sample.png` figure in the `test` folder.
+
 ## Acknowledgements
 
 We acknowledge support from the EPFL Open Science Fund via the [OSSCAR project](http://www.osscar.org/).