summaryrefslogtreecommitdiff
path: root/gemini
diff options
context:
space:
mode:
authortjpcc <tjp@ctrl-c.club>2023-01-19 10:12:30 -0700
committertjpcc <tjp@ctrl-c.club>2023-01-19 10:12:30 -0700
commit7d8fd812785ec924b238944e7b5d7c397f721ec9 (patch)
tree8f2f05f240dcd13aeaea74ce11062dd30de3f501 /gemini
parentf569df6eade1373dee7116ceac977636bdfc8edc (diff)
package documentation: gemini, gemtext, contrib
Diffstat (limited to 'gemini')
-rw-r--r--gemini/doc.go10
-rw-r--r--gemini/gemtext/doc.go7
2 files changed, 17 insertions, 0 deletions
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