Leave comments link on gopher page

[sgblog.git] / README

diff --git a/README b/README
index 20fd5fd8076ccbd67b3be07f82375868c8f20beb..282be72f157f9b8fcb2ab31e0d4e408735953c0f 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,12 @@
-                SGBlog -- Git-based CGI blogging engine
-                =======================================
+            SGBlog -- Git-based CGI/inetd blogging/phlogging engine
+            =======================================================
 
 DESCRIPTION
 
-SGBlog is a simple blogging engine with a Git-based storage and CGI
-interface with HTTP-server. It can be used as a cgit replacement for
-readonly Git repository viewing and Atom feed generation. But it has
-better features:
+SGBlog is a simple blogging engine with a Git-based storage, CGI
+interface for HTTP-server, inetd interface for serving as Gopher server.
+It can be used as a cgit replacement for readonly Git repository viewing
+and Atom feed generation. But it has better features:
 
 * URLs are tried to be converted to clickable links
 * SHA1 hashes are tried to be converted to blog links itself
@@ -14,6 +14,7 @@ better features:
 * Each page has ETag and it is checked against the request for client-side
   caching
 * Pages can be gzip-compressed, depending on Accept-Encoding header
+* Gopher protocol support for phlog creation
 * Commenting support
 
 CONFIGURATION
@@ -49,6 +50,22 @@ SGBlog is configured via Hjson configuration file:
       CommentsEmail: something@example.com
     }
 
+Gopher mode can use the same configuration file, but it requires much
+less options:
+
+    {
+      GitPath: /home/git/pub/stargrave-blog.git
+      Branch: refs/heads/english
+      Title: "English Stargrave's blog"
+
+      AboutURL: http://blog.stargrave.org/
+
+      CommentsNotesRef: refs/notes/comments
+      CommentsEmail: something@example.com
+
+      GopherDomain: phlog.stargrave.org
+    }
+
 COMMENTS
 
 Each comment is just a plaintext with From and Date headers. They are