From: Urban Wallasch <urban.wallasch@freenet.de>
Date: Sat, 6 Apr 2019 13:19:25 +0000 (+0200)
Subject: * Added README.md.
X-Git-Tag: v0.2^0
X-Git-Url: https://git.packet-gain.de/?a=commitdiff_plain;h=65f7b2a21ab0b7b3096982bd2e68b1822655b275;p=gogopherd.git

* Added README.md.
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f0c00c3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,81 @@
+# Gogopherd
+
+Gogopherd is a simple gopher server written in Go.
+
+
+## Background
+
+The Gopher protocol is a TCP/IP application layer protocol designed
+for distributing, searching, and retrieving documents over the
+Internet.
+The Gopher protocol was strongly oriented towards a menu-document
+design and presented an alternative to the World Wide Web in its
+early stages, but ultimately Hypertext Transfer Protocol (HTTP)
+became the dominant protocol. The Gopher ecosystem is often regarded
+as the effective predecessor of the World Wide Web.
+_(Source: Wikipedia)_
+
+
+## Motivation
+
+For the fun of it. Also, given the golang.org mascot, what could be
+more appropriate?
+
+
+## Installation
+
+The Go code has no dependencies beyond the core packages, no external
+packages are referenced. A Makefile is provided to regenerate the
+`version.go` file and then call `go build` to build the executable.
+
+
+## Usage
+
+The `gogopherd` executable recognizes the following command line
+options:
+
+```
+  -M string
+        index greeter message
+
+  -d
+        allow access to dotfiles
+
+  -f string
+        fully qualified domain name (default "localhost")
+
+  -h
+        show this help page
+
+  -i string
+        interface to bind to (default "localhost")
+
+  -l
+        allow directory listings
+
+  -p string
+        TCP port to listen on (default "7070")
+
+  -r string
+        document root directory (default ".")
+
+  -s
+        follow symbolic links
+
+  -v
+        produce verbose output
+```
+
+
+## Release History
+
+| Version  | Comment                                   |
+| -------- | ----------------------------------------- |
+| 0.1      | Smoky pocket gopher (Cratogeomys fumosus) |
+| 0.2      | Desert pocket gopher (Geomys arenarius)   |
+
+
+## License
+
+Gogopherd is distributed under the Modified ("3-clause") BSD License.
+See `LICENSE` file for more information.