From 7d8fd812785ec924b238944e7b5d7c397f721ec9 Mon Sep 17 00:00:00 2001
From: tjpcc <tjp@ctrl-c.club>
Date: Thu, 19 Jan 2023 10:12:30 -0700
Subject: package documentation: gemini, gemtext, contrib

---
 contrib/doc.go        |  4 ++++
 gemini/doc.go         | 10 ++++++++++
 gemini/gemtext/doc.go |  7 +++++++
 3 files changed, 21 insertions(+)
 create mode 100644 contrib/doc.go
 create mode 100644 gemini/doc.go
 create mode 100644 gemini/gemtext/doc.go

diff --git a/contrib/doc.go b/contrib/doc.go
new file mode 100644
index 0000000..8c6a99b
--- /dev/null
+++ b/contrib/doc.go
@@ -0,0 +1,4 @@
+/*
+Contrib contains sub-packages with specific functionality for small web servers.
+*/
+package contrib
diff --git a/gemini/doc.go b/gemini/doc.go
new file mode 100644
index 0000000..b500799
--- /dev/null
+++ b/gemini/doc.go
@@ -0,0 +1,10 @@
+/*
+The gemini package contains everything needed for building clients and servers on the gemini protocol.
+
+There are server and client implementations, parsers, formatters, and constructors for gemini requests
+and responses, and a utility for building a gemini-ready TLS configuration.
+
+The gemtext subpackage is a library usefor for parsing and otherwise using gemtext documents, including
+transforming them into a few other languages with overridable templates.
+*/
+package gemini
diff --git a/gemini/gemtext/doc.go b/gemini/gemtext/doc.go
new file mode 100644
index 0000000..1d5340a
--- /dev/null
+++ b/gemini/gemtext/doc.go
@@ -0,0 +1,7 @@
+/*
+The gemtext package contains a gemtext AST and parser.
+
+Conversion sub-packages can convert this AST into other document types, and support
+overridable templates.
+*/
+package gemtext
-- 
cgit v1.2.3