From 7e1ecc4df44d20d2c9de1c8885ddc2c188062ef0 Mon Sep 17 00:00:00 2001
From: Brian Picciano <me@mediocregopher.com>
Date: Wed, 3 Jul 2024 12:36:05 +0200
Subject: Initial implementation of the gemtext template extension

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 52f3019..2a146ba 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,34 @@
 
 TODO proper introduction
 
+## Build
+
+TODO
+
+## Plugins
+
+The following plugins are implemented in this module.
+
+### http.handlers.templates.functions.gemtext
+
+This extension to `templates` allows for rendering a [gemtext][gemtext] string
+as a roughly equivalent set of HTML tags. It is similar to the [markdown template
+function][mdfunc] in its usage. It can be enabled by being included in the
+`templates.extensions` set.
+
+```
+templates {
+    extensions {
+        gemtext
+    }
+}
+```
+
+See the `template.localhost` virtual host in `example/Caddyfile` for an example
+of using the `gemtext` template to render a gemtext file within an HTML file.
+
+[gemtext]: https://geminiprotocol.net/docs/gemtext.gmi
+
 ## Development
 
 A nix-based development environment is provided with the correct versions of all
-- 
cgit v1.2.3