Update docs

README.md

@@ -40,6 +40,8 @@ The reporter supports the following configuration options:
 | showError | Show error message in summary | `false` |
 | includeResults | Define which types of test results should be shown in the summary | `['pass', 'skipped', 'fail', 'flaky']` |
 | quiet | Do not show any output in the console | `false` |
+| azureStorageUrl | URL to the Azure Storage account where the screenshots are stored (optional) | `""` |
+| azureStorageSAS | Shared Access Signature (SAS) token to access the Azure Storage account (optional) | `""` |
 
 To use these option, you can update the reporter configuration:
 
@@ -66,4 +68,50 @@ export default defineConfig({
 
 ![Example with details](./assets/example-with-details.png)
 
+## Showing result attachments
+
+If you want to show attachments like when you use pixel matching, you need to provide the configuration for the blob service where the images will be stored.
+
+> [!NOTE]
+> GitHub does not have an API to link images to the summary. Therefore, you need to store the images in a blob storage service and provide the URL to the images.
+
+> [!IMPORTANT]
+> To show the attachments, you need to make sure to enable `showError` as well.
+
+![Example with attachments](./assets/example-with-attachments.png)
+
+### Azure Blob Storage
+
+If you are using Azure Blob Storage, you need to provide the `azureStorageUrl` and `azureStorageSAS` configuration options.
+
+Follow the next steps to get the URL and SAS token:
+
+- Go to your Azure Portal
+- Navigate to your storage account or create a new one
+- Navigate to **data storage** > **containers**
+- Create a new container. Set the access level to **Blob (anonymous read access for blobs only)**
+- Open the container, and click on **Shared access signature**
+- Create a new shared access signature with the following settings:
+  - Allowed permissions: **Add**
+  - Expiry time: **Custom** (set the time you want)
+  - Allowed protocols: **HTTPS only**
+- Click on **Generate SAS and URL**
+- Copy the **Blob SAS token**, this will be your `azureStorageSAS` value
+- Copy the **Blob service URL** and append the container name to it, this will be your `azureStorageUrl` value. Example: `https://<name>.blob.core.windows.net/<container-name>`.
+- Update the `playwright.config.js` file with the following configuration:
+
+```ts
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  reporter: [
+    ['@estruyf/github-actions-reporter', {
+      showError: true,
+      azureStorageUrl: 'https://<name>.blob.core.windows.net/<container-name>',
+      azureStorageSAS: '<your-sas-token>'
+    }]
+  ],
+});
+```
+
 [![Visitors](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Festruyf%2Fplaywright-github-actions-reporter&countColor=%23263759)](https://visitorbadge.io/status?path=https%3A%2F%2Fgithub.com%2Festruyf%2Fplaywright-github-actions-reporter)