From b7d85735a42cac3a6941e6b7fd20d7f03655cf82 Mon Sep 17 00:00:00 2001
From: "Joshua A. Anderson" <joaander@umich.edu>
Date: Wed, 5 Jun 2024 10:11:14 -0400
Subject: [PATCH] Document setup-mdbook.

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 741f112..0e823ee 100644
--- a/README.md
+++ b/README.md
@@ -24,9 +24,27 @@ steps:
   with:
     python-version: "3.12"
 - name: Set up Python environment
-  uses: glotzerlab/workflows/setup-python@<insert hash of tagged version here> # v0.1.0
+  uses: glotzerlab/workflows/setup-uv@<insert hash of tagged version here> # v0.1.0
   with:
     lockfile: "requirements.txt"
 ```
 
 [uv]: https://github.com/astral-sh/uv
+
+## setup-mdbook
+
+`setup-mdbook` installs [mdbook] and *optionally* installs mdbook plugins:
+* [mdbook-linkcheck]
+
+In your action workflow:
+```yaml
+steps:
+- name: Set up mdbook
+  uses: glotzerlab/workflows/setup-mdbook@<insert hash of tagged version here> # v0.1.0
+```
+
+See [setup-mdbook/action.yaml] for all options.
+
+[mdbook]: https://rust-lang.github.io/mdBook/
+[mdbook-linkcheck]: https://github.com/Michael-F-Bryan/mdbook-linkcheck
+[setup-mdbook/action.yaml]: setup-mdbook/action.yaml