From 37fec5fd07d39fb5cfc24336a9589333b21f0157 Mon Sep 17 00:00:00 2001
From: "Rodweil, Theodor" <theodor.rodweil@victory-k.it>
Date: Mon, 7 Aug 2023 02:45:51 +0200
Subject: [PATCH] docs(README): add manifest example

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

diff --git a/README.md b/README.md
index 351280c..4a10a3c 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,47 @@ For a reference implementation of an external publisher, please refer to
 [PSConfluencePublisher](https://bitbucket.org/victorykit/psconfluencepublisher),
 a standalone PowerShell publisher for *Atlassian Confluence Builder for Sphinx*.
 
+The following is a sample manifest generated from the default sample:
+
+```
+{
+    "Pages": [
+        {
+            "Title": "Default Sample~",
+            "Ref": "pages/Default+Sample~.xml"
+        },
+        {
+            "Title": "Cats",
+            "Ref": "pages/Cats.xml",
+            "AncestorTitle": "Default Sample~"
+        }
+    ],
+    "Attachments": [
+        {
+            "Name": "pexels-just-a-couple-photos-3777622.jpg",
+            "ContainerPageTitle": "Cats",
+            "MimeType": "image/jpeg",
+            "Ref": "attachments/pexels-just-a-couple-photos-3777622.jpg"
+        },
+        {
+            "Name": "pexels-sami-aksu-14356302.jpg",
+            "ContainerPageTitle": "Cats",
+            "MimeType": "image/jpeg",
+            "Ref": "attachments/pexels-sami-aksu-14356302.jpg"
+        },
+        {
+            "Name": "objects.inv",
+            "ContainerPageTitle": "Default Sample~",
+            "MimeType": "application/octet-stream",
+            "Ref": "attachments/objects.inv"
+        }
+    ]
+}
+```
+
+> **NOTE**: The manifest's schema is currently part of the
+  [PSConfluencePublisher](https://bitbucket.org/victorykit/psconfluencepublisher)
+
 ## Installing
 
 You can install this extension via PyPI (through pip):