diff options
| -rw-r--r-- | README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..d1b278a --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +## gprsh -- A simple Gopher server in a POSIX shell script + + +`gprsh` is a Gopher server in a shell script. It requires only a +standard `netcat`. + +You start the server using: + + $ ./gprsh [<PORT> [<GOPHERDIR>] + +If PORT is not specified, it will bind on port 70. If GOPHERDIR is not +provided, it defaults to "./". + +`gprsh` reads the index.gph gopherfile in a folder and renders it as a +gophermap. |