From 4cc731f1f5bc3184418c8ba9a36610f942c9d2b3 Mon Sep 17 00:00:00 2001
From: Tim Paine <3105306+timkpaine@users.noreply.github.com>
Date: Wed, 19 Nov 2025 11:50:05 -0500
Subject: [PATCH] Update readme with action

---
 .github/workflows/{docs.yml => docs.yaml} |  1 -
 README.md                                 | 22 ++++++++++++++++++++++
 2 files changed, 22 insertions(+), 1 deletion(-)
 rename .github/workflows/{docs.yml => docs.yaml} (86%)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yaml
similarity index 86%
rename from .github/workflows/docs.yml
rename to .github/workflows/docs.yaml
index e729d205..aad7d2a0 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yaml
@@ -3,7 +3,6 @@ on:
   push:
     branches: ["main"]
     tags: ["v*"]
-    paths-ignore: ["LICENSE", "README.md"]
   workflow_dispatch:
 permissions:
     contents: write
diff --git a/README.md b/README.md
index 5994b4a6..b5e66df3 100644
--- a/README.md
+++ b/README.md
@@ -41,5 +41,27 @@ Or from `conda-forge` via `conda`:
 conda install yardang -c conda-forge
 ```
 
+## GitHub Action
+
+A convenient [github action](https://github.com/actions-ext/yardang) is provided to publish documentation automatically in CI.
+
+```yaml
+name: Docs
+on:
+  push:
+    branches: ["main"]
+    tags: ["v*"]
+  workflow_dispatch:
+permissions:
+    contents: write
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions-ext/yardang@main
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+```
+
 > [!NOTE]
 > This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).