From 55a219f14548647fa28cd8f187a9ac593e3af5cf Mon Sep 17 00:00:00 2001
From: spwoodcock <sam.woodcock@protonmail.com>
Date: Thu, 28 Sep 2023 14:26:03 +0100
Subject: [PATCH] docs: add example usage of pypi publish workflow

---
 docs/pypi_publish.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/docs/pypi_publish.md b/docs/pypi_publish.md
index ad3412c..e045cca 100644
--- a/docs/pypi_publish.md
+++ b/docs/pypi_publish.md
@@ -21,3 +21,21 @@ No outputs.
 <!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
 No secrets.
 <!-- AUTO-DOC-SECRETS:END -->
+
+## Example Usage
+
+```yaml
+name: Publish to PyPi.org
+
+on:
+  release:
+    types: [published]
+  # Allow manual trigger (workflow_dispatch)
+  workflow_dispatch:
+
+jobs:
+  publish_to_pypi:
+    uses: hotosm/gh-workflows/.github/workflows/pypi_publish.yml@main
+    secrets:
+      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+```
\ No newline at end of file