Add a README.md describing the extension

README.md

@@ -0,0 +1,42 @@
+# HSNR-themed Revealjs Extension For Quarto
+
+A [quarto extension](https://quarto.org/docs/extensions/) featuring an HSNR-inspired theme for the [reveal.js format](https://quarto.org/docs/presentations/revealjs/).
+
+See the included [template.qmd](template.qmd) file for an example of the theme and integration into Quarto or explore the rendered version [here](http://quarto.thecoatlessprofessor.com/hsnr-revealjs/).
+
+For details on how to convert from a single-themed document into a Quarto Extension for RevealJS see [PR #1](https://github.com/coatless-quarto/hsnr-revealjs/pull/1)
+
+## Installing
+
+You can obtain a copy of the extension by using:
+
+```bash
+quarto use template coatless-quarto/hsnr-revealjs
+```
+
+This will install the extension and create an example qmd file that
+you can use as a starting place for your presentation slides.
+
+## Using
+
+Once the extension is installed, you can use the extension by setting the `format` inside of the document header to `hsnr-revealjs`.
+
+```markdown
+---
+title: A title
+subtitle: A subtitle
+format:
+  hsnr-revealjs: default
+author:
+  - name: Your Name
+    orcid: 0000-0000-0000-0000
+    email: [email protected]
+    affiliations: Your Institution
+date: last-modified
+---
+```
+
+## Acknowledgements
+
+This theme was developed as a result of answering a question asked by [Joe Slam](https://github.com/produnis) on the [Quarto issue tracker (#7470)](https://github.com/quarto-dev/quarto-cli/issues/7470#issuecomment-1875929330).
+