From a636fc9277b60a32b210b9a3aa8732c04eefc804 Mon Sep 17 00:00:00 2001
From: dre <dre@nox.im>
Date: Mon, 12 Jul 2021 18:50:08 +0800
Subject: [PATCH] add package synopsis

---
 fileserver/fileserver.go | 2 ++
 gemini/gemini.go         | 2 ++
 middleware/doc.go        | 3 +++
 3 files changed, 7 insertions(+)
 create mode 100644 middleware/doc.go

diff --git a/fileserver/fileserver.go b/fileserver/fileserver.go
index 5869f3b..5f6b3b3 100644
--- a/fileserver/fileserver.go
+++ b/fileserver/fileserver.go
@@ -1,3 +1,5 @@
+// Package fileserver implements a gemini handler function to serve files with optional auto
+// indexing for directory listings.
 package fileserver
 
 import (
diff --git a/gemini/gemini.go b/gemini/gemini.go
index 0be2c41..ec5b058 100644
--- a/gemini/gemini.go
+++ b/gemini/gemini.go
@@ -1,3 +1,5 @@
+// Package gemini implements the protocol for use with a file server, certificate generation and
+// facilities for interceptors and middlewares.
 package gemini
 
 import (
diff --git a/middleware/doc.go b/middleware/doc.go
new file mode 100644
index 0000000..3ea4c02
--- /dev/null
+++ b/middleware/doc.go
@@ -0,0 +1,3 @@
+// Package middleware add few reusable middleware packages that work together with the gemini
+// package.
+package middleware