git » dnss » commit 604b52e

dnss: Add package-level documentation

author Alberto Bertogli
2017-11-19 13:54:52 UTC
committer Alberto Bertogli
2017-11-19 13:54:52 UTC
parent eafe242c136ced596a6a09b70cb0075406940f65

dnss: Add package-level documentation

dnss.go +11 -0

diff --git a/dnss.go b/dnss.go
index e2f9077..cff5166 100644
--- a/dnss.go
+++ b/dnss.go
@@ -1,3 +1,14 @@
+// dnss is a tool for encapsulating DNS over HTTPS.
+//
+// It can act as a DNS-to-HTTPS proxy, using dns.google.com as a server, or
+// anything implementing the same API.
+//
+// It can also act as an HTTPS-to-DNS proxy, so you can use it instead of
+// dns.google.com if you want more control over the servers and the final DNS
+// server used (for example if you are in an isolated environment, such as a
+// test lab or a private network).
+//
+// See the README.md file for more details.
 package main
 
 import (