about summary refs log tree commit diff
diff options
context:
space:
mode:
authorsternenseemann <git@lukasepple.de>2017-01-04 15:20:11 +0100
committersternenseemann <git@lukasepple.de>2017-01-04 15:20:11 +0100
commitdbe007585771e9ecd4157eb2c3a4667098dbec85 (patch)
tree7d98e5d410bcd487a2eef5d417e2d048db8add3c
parent3b8952e95599f43d8d92ed535ab15856a9b099a2 (diff)
Add hints and roadmap to README
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 8dd64be..e6230bc 100644
--- a/README.md
+++ b/README.md
@@ -21,3 +21,13 @@ option                | meaning
 `--listen-public`     | If this flag is set, gopher-proxy will accept connections on its public IP address(es).
 `--default-mime-type` | Mime type to use if spacecookie can't guess it, defaults to "application/octet-stream"
 `--timeout`           | Timeout when connecting in milliseconds, defaults to 10 seconds.
+
+## Things to keep in mind
+
+* Your gopher server must send UTF-8-encoded responses or gopher-proxy will break (I will improve this)
+* gopher-proxy might misinterpret certain content, because of the context-sensitive nature of gopher
+* gopher-proxy does not support Gopher+
+
+## Roadmap
+
+[ ] Add Logging