From 865e1f6f38e5be9340d57a2397ff1d7dfede4def Mon Sep 17 00:00:00 2001
From: Brent Yi <yibrenth@gmail.com>
Date: Tue, 18 Oct 2022 17:55:58 -0700
Subject: [PATCH] Strip unsupported HTML tags for PyPI readme

---
 .github/workflows/publish.yml |  3 +++
 README.md                     | 12 +++++++++++-
 2 files changed, 14 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index b98736e4..3ec10a53 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -22,6 +22,9 @@ jobs:
       run: |
         curl -sSL https://install.python-poetry.org | python3 -
         poetry install
+    - name: Strip unsupported tags in README
+      run: |
+        sed -i '/<!-- pypi-strip -->/,/<!-- \/pypi-strip -->/d' README.md
     - name: Build and publish
       env:
         PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
diff --git a/README.md b/README.md
index 538428c1..a4eee0ab 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,20 @@
 <br />
 <p align="center">
-    <!-- Note that image URLs should all be absolute; this README will be used for both GitHub and PyPI. -->
+    <!--
+    Note that this README will be used for both GitHub and PyPI.
+    We therefore:
+    - Keep all image URLs absolute.
+    - In the GitHub action we use for publishing, strip some HTML tags that aren't supported by PyPI.
+    -->
+    <!-- pypi-strip -->
     <picture>
         <source media="(prefers-color-scheme: dark)" srcset="https://brentyi.github.io/tyro/_static/logo-dark.svg" />
+    <!-- /pypi-strip -->
         <img alt="tyro logo" src="https://brentyi.github.io/tyro/_static/logo-light.svg" width="200px" />
+    <!-- pypi-strip -->
     </picture>
+    <!-- /pypi-strip -->
+
 </p>
 
 <p align="center">